Parameterized documentation. #673
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
It should be handled by a packaging script, not a build script.
sharkdp
reviewed
Sep 28, 2019
|
|
||
| // Read environment variables. | ||
| lazy_static! { | ||
| pub static ref PROJECT_NAME: &'static str = option_env!("PROJECT_NAME").unwrap_or("bat"); |
There was a problem hiding this comment.
Cool! I didn't know option_env!(…).
sharkdp
approved these changes
Sep 28, 2019
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.
Fixes #659.
Although it's slightly overkill, this uses Liquid for templating.
It's a well-tested templating engine, and it shouldn't break anytime soon.
Changes
doc/bat.1toassets/manual/bat.1.inassets/completions/bat.fishtoassets/completions/bat.fish.in.gitignore.Keeping them in the repo is redundant, and it will discourage people from copying them directly from GitHub.
Information
Certain information is now parameterized using environment variables:
PROJECT_NAME-- Set this to change the project name (default:bat).PROJECT_EXECUTABLE-- Set this to change the executable name (in documentation only; default: value ofPROJECT_NAME).Caveats
The executable name can't be changed from an environment variable.
For this reason, I'm also keeping the generated files as
bat.*.If any of the files need to be renamed when packaging, it should be done in an external packaging script.