Add detailed man page documentation and minor fixes#124
Merged
Conversation
Contributor
|
Let me know if you would like help with the Makefile. I think the one for the ochami CLI is pretty tuned. |
Collaborator
Author
|
@synackd I had already started copying from the ochami Makefile, but if you want to take over that would be appreciated. |
Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
The config.env file was removed in favor of setting variables on the command line e.g: make prefix=/my/install/path install Recipes also have been reordered alphabetically based on the target. Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
davidallendj
commented
Sep 29, 2025
davidallendj
commented
Sep 29, 2025
Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
synackd
reviewed
Sep 29, 2025
synackd
left a comment
synackd
left a comment
Contributor
There was a problem hiding this comment.
Initial manual pages look good! Just caught a few things to be addressed. I also refactored the Makefile and included a target to build the man pages.
make man
make clean-man
You can also build individual ones:
make man/magellan.1
synackd
reviewed
Sep 30, 2025
davidallendj
changed the title
synackd
requested changes
Oct 1, 2025
synackd
left a comment
synackd
left a comment
Contributor
There was a problem hiding this comment.
Largely looks good, there are just a few small things and an scdoc compilation error that needs addressing.
Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>
synackd
approved these changes
Oct 1, 2025
synackd
left a comment
synackd
left a comment
Contributor
There was a problem hiding this comment.
Fixed some newline issues I saw in magellan(1). Other than that, LGTM.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds man pages documentation as well as some minor fixes to the cobra CLI help strings. Each man page helps to further document the behavior of the CLI detailing more about how each flag works with information that is not included in the help strings (i.e. documentation from
--help).Edit: This PR also adds a couple of minor fixes, such as
scannot writing to the database properly.To generate and view the docs:
scdocusing package managerman:TODO: