Skip to content

API Docs: process #29370

Closed
Closed
API Docs: process#29370
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priority

Description

@steveklabnik
steveklabnik
opened on Oct 26, 2015

Part of #29329

http://doc.rust-lang.org/std/process/

Here's what needs to be done to close out this issue:

  • the module docs are okay but could use elaboration.
  • abort needs an example, preferably showing off its destuctor behavior. (some elaboration here, and a first PR here)
  • abort should also talk about its relationship with panic!, specifically, unwinding vs aborting panics.
  • abort has a bug: The [abort] function terminates the process, the []s need to be dropped.
  • Child the Note shouldn't be one, and should come before the examples.
  • ChildStderr should have its second sentence as not a summary, needs some newlines.
  • ChildStdin has the same issue.
  • ChildStdout has the same issue.
  • Command is good but many of its methods could use more elaboration in their docs. See below for some details.
  • ExitStatus should link to status, and its code method needs an example.
  • Output should link to output.
  • Stdio should link to stdio and needs expanded explanations and examples.
  • exit needs some examples to show its behavior. An example of how people use this in main would be fantastic too.

With regards to Command, @frewsxcv brought up in #40983 that

  • stdin, stdout, and stderr should specify what the default behavior is if they aren't explicitly called.

And @retep998 mentions

Note that the default behavior depends on whether the child process is using the console subsystem or windows subsystem. Console subsystem apps will inherit your stdout/stdin/stderr while windows subsystem apps will start with no stdout/stdin/stderr unless you explicitly assign them.

Activity

  1. steveklabnik
    added
    A-docs
    on Oct 26, 2015

  2. LukasKalbertodt commented on Jan 30, 2016

    @LukasKalbertodt
    LukasKalbertodt
    on Jan 30, 2016
    Contributor

    This API really could use a better documentation. To list all failure cases of several functions would be great :)

  3. steveklabnik
    added 5 commits that reference this issue on May 5, 2016

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    5df157b

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    35ff573

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    8cc4298

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    6fdd39a
  4. GuillaumeGomez
    added a commit that references this issue on May 7, 2016

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    08e2b33
  5. steveklabnik
    added 2 commits that reference this issue on May 7, 2016

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    ba6678c

    Rollup merge of rust-lang#33283 - GuillaumeGomez:process_doc, r=steve…

    93285f8
  6. steveklabnik
    added
    E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
    on Mar 8, 2017

  7. steveklabnik commented on Mar 8, 2017

    @steveklabnik
    steveklabnik
    on Mar 8, 2017
    ContributorAuthor

    I am happy to mentor anyone who wants to tackle this issue.

  8. steveklabnik
    added
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Mar 10, 2017
  9. steveklabnik
    added
    P-mediumMedium priority
    and removed
    A-docs
    on Mar 24, 2017

  10. 52 remaining items

  11. mgattozzi commented on Oct 8, 2017

    @mgattozzi
    mgattozzi
    on Oct 8, 2017
    Contributor

    @steveklabnik the two abort check boxes should be ticked off now that #44905 was merged

  12. mistodon
    added a commit that references this issue on Oct 8, 2017

    Add links and examples for std::process::Stdio

    19029d5

  13. Technius commented on Oct 13, 2017

    @Technius
    Technius
    on Oct 13, 2017
    Contributor

    I'd like to help improve the module docs.

  14. steveklabnik commented on Oct 13, 2017

    @steveklabnik
    steveklabnik
    on Oct 13, 2017
    ContributorAuthor

    @Technius that'd be great! Let me know if you need any help!

  15. kennytm
    added 3 commits that reference this issue on Oct 14, 2017

    Rollup merge of rust-lang#45113 - Pirh:process_output_links, r=stevek…

    6815f1e

    Rollup merge of rust-lang#45113 - Pirh:process_output_links, r=stevek…

    430ac4b

    Rollup merge of rust-lang#45151 - Pirh:stdio_default_docs, r=frewsxcv

    18f2895

  16. mistodon commented on Oct 17, 2017

    @mistodon
    mistodon
    on Oct 17, 2017

    The ExitStatus, Output, and Stdio can be checked off now, as well as the default behaviour of stdin/stdout/stderr.

    The Command box can possibly also be checked off (at least it looks good to me, not sure what other detail is needed).

    All that's left (I think) is module level documentation, and an explanation of how stdio works in different Windows subsystems.

  17. frewsxcv
    added a commit that references this issue on Oct 28, 2017

    Rollup merge of rust-lang#45295 - Technius:docs/process, r=steveklabnik

    0aad849
  18. bors
    added a commit that references this issue on Oct 29, 2017

    Auto merge of #45295 - Technius:docs/process, r=steveklabnik

    7d475a2

  19. steveklabnik commented on Jan 8, 2019

    @steveklabnik
    steveklabnik
    on Jan 8, 2019
    ContributorAuthor

    I'm giving this issue a close. Thank you to everyone who's pitched in on these docs over the last few years. If there's still improvements to do here, please open a new issue, one per thing. Thanks!

  20. steveklabnik
    closed this as completedon Jan 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCE-help-wantedCall for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priority

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions