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.

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

RFC: man: removing dependency on asciidoctor #80

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

larrydewey
Copy link
Contributor

There is some controversy around relying on a third-party application for building the projects man-pages. This introduces a heavy refactor which removes that dependency and instead relies solely on clap and clap_mangen to dynamically generate man-pages for the project.

Overview:

  • Delete the old build.rs script and moves it into the src directory to help clean up the depenency tree inside of the build script.
  • Delete the legacy adoc-formatted file.
  • Build a pseudo-library with cli.rs as the main portion of the project
  • Refactor main.rs to simply be a driver of the pseudo-library

There is some controversy around relying on a third-party application
for building the projects man-pages. This introduces a heavy refactor
which removes that dependency and instead relies solely on `clap` and
`clap_mangen` to dynamically generate man-pages for the project.

Overview:

- Delete the old `build.rs` script and moves it into the `src` directory
  to help clean up the depenency tree inside of the build script.
- Delete the legacy adoc-formatted file.
- Build a pseudo-library with `cli.rs` as the main portion of the project
- Refactor main.rs to simply be a driver of the pseudo-library

Signed-off-by: Larry Dewey <[email protected]>
Updating to 1.80.0

Signed-off-by: Larry Dewey <[email protected]>
@larrydewey larrydewey marked this pull request as draft September 18, 2024 16:36
@larrydewey larrydewey changed the title man: removing dependency on asciidoctor RFC: man: removing dependency on asciidoctor Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants