Generate man pages #92
Merged
Conversation
This file contains 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
A Makefile provides 'make' and 'make install' which generates and
installs for man pages.
Man pages are built for the binaries (valkey-cli, etc. prefixed by "valkey-",
section 1), Config (valkey.conf, section 4), Valkey commands (section 3valkey),
documentation overview page ("valkey", section 7) and tutorials and everything
else (prefixed by "valkey-", section 7).
Scripts in Python are used for preprocessing and pandoc is used to convert
markdown to man pages, stored under utils/.
A target 'make html' is also provided, to build HTML pages to use locally.
This is also using pandoc.
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
This commit adds usage details to the pages for these programs, making them a bit closer to the structure of standard man pages for programs. Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
|
|
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech> Co-authored-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
|
@Conan-Kudo @guillemj FYI |
madolson
reviewed
May 23, 2024
madolson
reviewed
May 23, 2024
madolson
reviewed
May 23, 2024
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech> Co-authored-by: Madelyn Olson <madelyneolson@gmail.com>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
madolson
reviewed
May 23, 2024
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Delete parts of RSAL which weren't deleted in 8f8e4bf. Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
zuiderkwast
commented
May 23, 2024
enjoy-binbin
approved these changes
May 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A Makefile provides 'make' and 'make install' to generate and install man pages.
Man pages are built for the binaries (valkey-cli, etc. prefixed by "valkey-",
section 1), Config (valkey.conf, section 4), Valkey commands (section 3valkey),
documentation overview page ("valkey", section 7) and tutorials and everything
else (prefixed by "valkey-", section 7).
Scripts in Python are used for preprocessing and pandoc is used to convert
markdown to man pages, stored under utils/.
A target 'make html' is also provided, to build HTML pages to use locally.
This is also using pandoc.
The documentation pages for
valkey-cli,valkey-benchmarkandvalkey-sentinelare expanded with usage and options to match what's expected from a man page for a program. A page forvalkey-serveris added. (We didn't have one.)README.md is update with info on how to build and install man pages. Other info regarding the doc repo is slightly updated.
Fixes #69.
Reviewers: I suggest checking out my branch and trying
make -j10 VALKEY_ROOT=path/to/valkeyandsudo make install. Thenman valkeyto start with.