Skip to content

Commit

Permalink
Merge bitcoin#29849: Fix typos in subprocess.hpp
Browse files Browse the repository at this point in the history
13f5391 Fix typos in `subprocess.hpp` (Hennadii Stepanov)

Pull request description:

  Resolves one item in the bitcoin#28981 (review):
  >    - Remove linter exclusions and fix all issues.

  Based on upstream arun11299/cpp-subprocess#101.

ACKs for top commit:
  fanquake:
    ACK 13f5391

Tree-SHA512: 2ee27a5b7d1ba6f47a5148add155c918eadaaffb94a4b5dd3edea00e63440b87291c559361bf25a8db1567debff78cf7e9466dc34f14331ca1d426994837df93
  • Loading branch information
fanquake committed Apr 11, 2024
2 parents bdb33ec + 13f5391 commit 0de63b8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 16 deletions.
32 changes: 17 additions & 15 deletions src/util/subprocess.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Based on the https://github.com/arun11299/cpp-subprocess project.

/*!
Documentation for C++ subprocessing libraray.
Documentation for C++ subprocessing library.
@copyright The code is licensed under the [MIT
License](http://opensource.org/licenses/MIT):
Expand Down Expand Up @@ -106,7 +108,7 @@ namespace subprocess {
// from pipe
static const size_t SP_MAX_ERR_BUF_SIZ = 1024;

// Default buffer capcity for OutBuffer and ErrBuffer.
// Default buffer capacity for OutBuffer and ErrBuffer.
// If the data exceeds this capacity, the buffer size is grown
// by 1.5 times its previous capacity
static const size_t DEFAULT_BUF_CAP_BYTES = 8192;
Expand Down Expand Up @@ -312,8 +314,8 @@ namespace util
inline env_map_t MapFromWindowsEnvironment(){
wchar_t *variable_strings_ptr;
wchar_t *environment_strings_ptr;
std::wstring delimeter(L"=");
int del_len = delimeter.length();
std::wstring delimiter(L"=");
int del_len = delimiter.length();
env_map_t mapped_environment;

// Get a pointer to the environment block.
Expand All @@ -335,7 +337,7 @@ namespace util
// Create a string from Variable String
env_string_t current_line(variable_strings_ptr);
// Find the first "equals" sign.
auto pos = current_line.find(delimeter);
auto pos = current_line.find(delimiter);
// Assuming it's not missing ...
if(pos!=std::wstring::npos){
// ... parse the key and value.
Expand Down Expand Up @@ -433,8 +435,8 @@ namespace util
* Function: join
* Parameters:
* [in] vec : Vector of strings which needs to be joined to form
* a single string with words seperated by a seperator char.
* [in] sep : String used to seperate 2 words in the joined string.
* a single string with words separated by a separator char.
* [in] sep : String used to separate 2 words in the joined string.
* Default constructed to ' ' (space).
* [out] string: Joined string.
*/
Expand Down Expand Up @@ -655,7 +657,7 @@ namespace util
* Default value is 0.
*/
struct bufsize {
explicit bufsize(int siz): bufsiz(siz) {}
explicit bufsize(int sz): bufsiz(sz) {}
int bufsiz = 0;
};

Expand Down Expand Up @@ -711,7 +713,7 @@ struct string_arg
};

/*!
* Option to specify the executable name seperately
* Option to specify the executable name separately
* from the args sequence.
* In this case the cmd args must only contain the
* options required for this executable.
Expand All @@ -728,7 +730,7 @@ struct executable: string_arg
* Option to set the current working directory
* of the spawned process.
*
* Eg: cwd{"/som/path/x"}
* Eg: cwd{"/some/path/x"}
*/
struct cwd: string_arg
{
Expand Down Expand Up @@ -852,7 +854,7 @@ struct error
wr_ch_ = fd;
}
explicit error(IOTYPE typ) {
assert ((typ == PIPE || typ == STDOUT) && "STDERR not aloowed");
assert ((typ == PIPE || typ == STDOUT) && "STDERR not allowed");
if (typ == PIPE) {
#ifndef __USING_WINDOWS__
std::tie(rd_ch_, wr_ch_) = util::pipe_cloexec();
Expand All @@ -874,7 +876,7 @@ struct error
// ATTN: Can be used only to execute functions with no
// arguments and returning void.
// Could have used more efficient methods, ofcourse, but
// that wont yield me the consistent syntax which I am
// that won't yield me the consistent syntax which I am
// aiming for. If you know, then please do let me know.

class preexec_func
Expand Down Expand Up @@ -1211,10 +1213,10 @@ class Streams
* 9. communicate(...) - Get the output/error from the child and close the channels
* from the parent side.
*10. input() - Get the input channel/File pointer. Can be used for
* cutomizing the way of sending input to child.
* customizing the way of sending input to child.
*11. output() - Get the output channel/File pointer. Usually used
in case of redirection. See piping examples.
*12. error() - Get the error channel/File poiner. Usually used
*12. error() - Get the error channel/File pointer. Usually used
in case of redirection.
*13. start_process() - Start the child process. Only to be used when
* `defer_spawn` option was provided in Popen constructor.
Expand Down Expand Up @@ -1358,7 +1360,7 @@ class Popen

// Command in string format
std::string args_;
// Comamnd provided as sequence
// Command provided as sequence
std::vector<std::string> vargs_;
std::vector<char*> cargv_;

Expand Down
2 changes: 1 addition & 1 deletion test/lint/lint-spelling.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from lint_ignore_dirs import SHARED_EXCLUDED_SUBTREES

IGNORE_WORDS_FILE = 'test/lint/spelling.ignore-words.txt'
FILES_ARGS = ['git', 'ls-files', '--', ":(exclude)build-aux/m4/", ":(exclude)contrib/seeds/*.txt", ":(exclude)depends/", ":(exclude)doc/release-notes/", ":(exclude)src/qt/locale/", ":(exclude)src/qt/*.qrc", ":(exclude)contrib/guix/patches", ":(exclude)src/util/subprocess.hpp"]
FILES_ARGS = ['git', 'ls-files', '--', ":(exclude)build-aux/m4/", ":(exclude)contrib/seeds/*.txt", ":(exclude)depends/", ":(exclude)doc/release-notes/", ":(exclude)src/qt/locale/", ":(exclude)src/qt/*.qrc", ":(exclude)contrib/guix/patches"]
FILES_ARGS += [f":(exclude){dir}" for dir in SHARED_EXCLUDED_SUBTREES]


Expand Down

0 comments on commit 0de63b8

Please sign in to comment.