aboutsummaryrefslogtreecommitdiff
path: root/src/util/subprocess.h
diff options
context:
space:
mode:
authorSebastian Falbesoner <sebastian.falbesoner@gmail.com>2024-04-27 14:43:44 +0200
committerSebastian Falbesoner <sebastian.falbesoner@gmail.com>2024-04-28 14:18:06 +0200
commit8b52e7f628304e83b0e36fd97e617de0f71c5a62 (patch)
treef17bcf5eb9cda3bc0de62c13035550d68f236234 /src/util/subprocess.h
parent97f159776ec06f767df1d4990aa7d0859140f52f (diff)
update comments in cpp-subprocess (check_output references)
Remove obsolete `check_output` references in the comments and remove the numbering of the Popen API methods, as they don't seem to provide a value and just make diffs larger for future changes.
Diffstat (limited to 'src/util/subprocess.h')
-rw-r--r--src/util/subprocess.h37
1 files changed, 18 insertions, 19 deletions
diff --git a/src/util/subprocess.h b/src/util/subprocess.h
index 8c5f074918..af408b31d4 100644
--- a/src/util/subprocess.h
+++ b/src/util/subprocess.h
@@ -670,8 +670,8 @@ struct error
* This is basically used to determine the length of the actual
* data stored inside the dynamically resized vector.
*
- * This is what is returned as the output to communicate and check_output
- * functions, so, users must know about this class.
+ * This is what is returned as the output to the communicate
+ * function, so, users must know about this class.
*
* OutBuffer and ErrBuffer are just different typedefs to this class.
*/
@@ -704,8 +704,7 @@ class Popen;
namespace detail {
/*!
* A helper class to Popen class for setting
- * options as provided in the Popen constructor
- * or in check_output arguments.
+ * options as provided in the Popen constructor.
* This design allows us to _not_ have any fixed position
* to any arguments and specify them in a way similar to what
* can be done in python.
@@ -897,23 +896,23 @@ private:
* interface to the client.
*
* API's provided by the class:
- * 1. Popen({"cmd"}, output{..}, error{..}, ....)
+ * Popen({"cmd"}, output{..}, error{..}, ....)
* Command provided as a sequence.
- * 2. Popen("cmd arg1"m output{..}, error{..}, ....)
+ * Popen("cmd arg1", output{..}, error{..}, ....)
* Command provided in a single string.
- * 3. wait() - Wait for the child to exit.
- * 4. retcode() - The return code of the exited child.
- * 5. pid() - PID of the spawned child.
- * 6. poll() - Check the status of the running child.
- * 8. send(...) - Send input to the input channel of the child.
- * 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
- * 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 pointer. Usually used
- in case of redirection.
+ * wait() - Wait for the child to exit.
+ * retcode() - The return code of the exited child.
+ * pid() - PID of the spawned child.
+ * poll() - Check the status of the running child.
+ * send(...) - Send input to the input channel of the child.
+ * communicate(...) - Get the output/error from the child and close the channels
+ * from the parent side.
+ * input() - Get the input channel/File pointer. Can be used for
+ * customizing the way of sending input to child.
+ * output() - Get the output channel/File pointer. Usually used
+ in case of redirection. See piping examples.
+ * error() - Get the error channel/File pointer. Usually used
+ in case of redirection.
*/
class Popen
{