Skip to content

Commit 8b52e7f

Browse files
committed
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.
1 parent 97f1597 commit 8b52e7f

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

src/util/subprocess.h

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -670,8 +670,8 @@ struct error
670670
* This is basically used to determine the length of the actual
671671
* data stored inside the dynamically resized vector.
672672
*
673-
* This is what is returned as the output to communicate and check_output
674-
* functions, so, users must know about this class.
673+
* This is what is returned as the output to the communicate
674+
* function, so, users must know about this class.
675675
*
676676
* OutBuffer and ErrBuffer are just different typedefs to this class.
677677
*/
@@ -704,8 +704,7 @@ class Popen;
704704
namespace detail {
705705
/*!
706706
* A helper class to Popen class for setting
707-
* options as provided in the Popen constructor
708-
* or in check_output arguments.
707+
* options as provided in the Popen constructor.
709708
* This design allows us to _not_ have any fixed position
710709
* to any arguments and specify them in a way similar to what
711710
* can be done in python.
@@ -897,23 +896,23 @@ class Streams
897896
* interface to the client.
898897
*
899898
* API's provided by the class:
900-
* 1. Popen({"cmd"}, output{..}, error{..}, ....)
899+
* Popen({"cmd"}, output{..}, error{..}, ....)
901900
* Command provided as a sequence.
902-
* 2. Popen("cmd arg1"m output{..}, error{..}, ....)
901+
* Popen("cmd arg1", output{..}, error{..}, ....)
903902
* Command provided in a single string.
904-
* 3. wait() - Wait for the child to exit.
905-
* 4. retcode() - The return code of the exited child.
906-
* 5. pid() - PID of the spawned child.
907-
* 6. poll() - Check the status of the running child.
908-
* 8. send(...) - Send input to the input channel of the child.
909-
* 9. communicate(...) - Get the output/error from the child and close the channels
910-
* from the parent side.
911-
*10. input() - Get the input channel/File pointer. Can be used for
912-
* customizing the way of sending input to child.
913-
*11. output() - Get the output channel/File pointer. Usually used
914-
in case of redirection. See piping examples.
915-
*12. error() - Get the error channel/File pointer. Usually used
916-
in case of redirection.
903+
* wait() - Wait for the child to exit.
904+
* retcode() - The return code of the exited child.
905+
* pid() - PID of the spawned child.
906+
* poll() - Check the status of the running child.
907+
* send(...) - Send input to the input channel of the child.
908+
* communicate(...) - Get the output/error from the child and close the channels
909+
* from the parent side.
910+
* input() - Get the input channel/File pointer. Can be used for
911+
* customizing the way of sending input to child.
912+
* output() - Get the output channel/File pointer. Usually used
913+
in case of redirection. See piping examples.
914+
* error() - Get the error channel/File pointer. Usually used
915+
in case of redirection.
917916
*/
918917
class Popen
919918
{

0 commit comments

Comments
 (0)