Skip to content

Keep generated documentation for --help in a separate directory #9500

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

Merged
Ericson2314 merged 1 commit into from
Nov 30, 2023
Merged

Keep generated documentation for --help in a separate directory #9500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ perl/Makefile.config

/src/nix/nix

/src/nix/doc
/src/nix/generated-doc

# /src/nix-env/
/src/nix-env/nix-env
Expand Down
4 changes: 0 additions & 4 deletions src/nix/help-stores.md → doc/manual/src/store/types/index.md.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
R"(

Nix supports different types of stores. These are described below.

## Store URL format
Expand Down Expand Up @@ -42,5 +40,3 @@ store as follows:
* Otherwise, use the [local store](#local-store) `/nix/store`.

@stores@

)"
19 changes: 16 additions & 3 deletions src/nix/local.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,23 @@ src/nix/develop.cc: src/nix/get-env.sh.gen.hh

src/nix-channel/nix-channel.cc: src/nix-channel/unpack-channel.nix.gen.hh

src/nix/main.cc: doc/manual/generate-manpage.nix.gen.hh doc/manual/utils.nix.gen.hh doc/manual/generate-settings.nix.gen.hh doc/manual/generate-store-info.nix.gen.hh
src/nix/main.cc: \
doc/manual/generate-manpage.nix.gen.hh \
doc/manual/utils.nix.gen.hh doc/manual/generate-settings.nix.gen.hh \
doc/manual/generate-store-info.nix.gen.hh \
src/nix/generated-doc/help-stores.md

src/nix/doc/files/%.md: doc/manual/src/command-ref/files/%.md
src/nix/generated-doc/files/%.md: doc/manual/src/command-ref/files/%.md
@mkdir -p $$(dirname $@)
@cp $< $@

src/nix/profile.cc: src/nix/profile.md src/nix/doc/files/profiles.md.gen.hh
src/nix/profile.cc: src/nix/profile.md src/nix/generated-doc/files/profiles.md.gen.hh

src/nix/generated-doc/help-stores.md: doc/manual/src/store/types/index.md.in
@mkdir -p $$(dirname $@)
@echo 'R"(' >> $@.tmp
@echo >> $@.tmp
@cat $^ >> $@.tmp
@echo >> $@.tmp
@echo ')"' >> $@.tmp
@mv $@.tmp $@
2 changes: 1 addition & 1 deletion src/nix/main.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ struct CmdHelpStores : Command
std::string doc() override
{
return
#include "help-stores.md"
#include "generated-doc/help-stores.md"
;
}

Expand Down
2 changes: 1 addition & 1 deletion src/nix/profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ them to be rolled back easily.

)""

#include "doc/files/profiles.md.gen.hh"
#include "generated-doc/files/profiles.md.gen.hh"

R""(

Expand Down