Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document exit codes for dsc #178

Closed
michaeltlombardi opened this issue Aug 30, 2023 · 0 comments · Fixed by #179
Closed

Document exit codes for dsc #178

michaeltlombardi opened this issue Aug 30, 2023 · 0 comments · Fixed by #179
Labels
Issue-Documentation Improvements or additions to documentation

Comments

@michaeltlombardi
Copy link
Collaborator

michaeltlombardi commented Aug 30, 2023 •
edited
Loading

Summary of the new feature / enhancement

Currently, there's no documentation for the exit codes that dsc returns, even though they have semantic meaning:

DSC/dsc/src/util.rs

Lines 29 to 34 in 5a1f8b5

pub const EXIT_SUCCESS: i32 = 0;
pub const EXIT_INVALID_ARGS: i32 = 1;
pub const EXIT_DSC_ERROR: i32 = 2;
pub const EXIT_JSON_ERROR: i32 = 3;
pub const EXIT_INVALID_INPUT: i32 = 4;
pub const EXIT_VALIDATION_FAILED: i32 = 5;

These exit codes should be documented in the root command document.

Proposed technical implementation details (optional)

No response
@michaeltlombardi michaeltlombardi added the Issue-Documentation Improvements or additions to documentation label Aug 30, 2023
michaeltlombardi added a commit to michaeltlombardi/DSC that referenced this issue Aug 30, 2023
@michaeltlombardi
(PowerShellGH-178) Document dsc exit codes
d890bbd 
Prior to this change, the documentation for the `dsc` command did not
include the exit codes that it may return. This change adds a section
to the documentation that lists the exit codes and their meanings.

This information is particularly important to integrating tools, like
winget, that need to know the semantic meaning of the exit codes when
calling `dsc`.

- Resolves PowerShell#178
@michaeltlombardi michaeltlombardi mentioned this issue Aug 30, 2023
Merged
michaeltlombardi added a commit to michaeltlombardi/DSC that referenced this issue Aug 31, 2023
@michaeltlombardi
(PowerShellGH-178) Document dsc exit codes
22c8b40 
Prior to this change, the documentation for the `dsc` command did not
include the exit codes that it may return. This change adds a section
to the documentation that lists the exit codes and their meanings.

This information is particularly important to integrating tools, like
winget, that need to know the semantic meaning of the exit codes when
calling `dsc`.

- Resolves PowerShell#178
SteveL-MSFT added a commit to michaeltlombardi/DSC that referenced this issue Sep 1, 2023
@SteveL-MSFT
Merge branch 'main' into PowerShellgh-178/main/exit-codes
d115b00
SteveL-MSFT added a commit that referenced this issue Sep 1, 2023
@SteveL-MSFT
Merge pull request #179 from michaeltlombardi/gh-178/main/exit-codes
998d936 
(GH-178) Document `dsc` exit codes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Issue-Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-178) Document dsc exit codes michaeltlombardi/DSC
1 participant
@michaeltlombardi