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

meson: Generate documentation #10

Merged
merged 2 commits into from
Aug 5, 2021

Conversation

Pamplemousse
Copy link

@Pamplemousse Pamplemousse commented Aug 5, 2021

I tried to convert the doc/local.mk as closely as possible;

  • As some recipes were borderline shell scripts, and with meson's command feature not being very flexible, I ended up writing scripts in scripts/manual to be able to perform the needed actions.
    Also, I noted that some scripts were very similar, but I didn't try really hard to turn that into a unique parameterized script (it's not trivial);
  • It relies on doc/manual: don't need to copy highlight.js manually NixOS/nix#5094 but fix could always be added if the PR is not accepted upstream (merged!);
  • meson install failed because of compilation errors, so I couldn't check that.

cc @Ericson2314

Signed-off-by: Pamplemousse <[email protected]>
@p01arst0rm
Copy link
Owner

looks good, nice work! it may be easier to seperate out the generation of different files into different directories, like is done in the include & dependency directories. makes things a bit easier to find :)

'flake-prefetch.md', 'store-ls.md', 'add-file.md', 'flake-show.md', 'build.md', 'registry-remove.md',
'print-dev-env.md', 'store-cat.md', 'log.md', join_paths('realisation', 'info.md'),
)

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you please newline these file names to improve readability?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I generally agree, I don't for that file:
There is a substantial amount of source files that are declared, forcing to scroll quite a bit already to go to the interesting part (IMO, executable declarations are more important than lines and lines of files).

scripts/manual/write-summary.sh Show resolved Hide resolved
scripts/manual/write-conf-file.sh Show resolved Hide resolved
scripts/manual/write-builtins.sh Show resolved Hide resolved
scripts/manual/prepend-title-to-manpage.sh Show resolved Hide resolved
doc/manual/src/expressions/meson.build Show resolved Hide resolved
doc/manual/src/command-ref/meson.build Show resolved Hide resolved
doc/manual/meson.build Show resolved Hide resolved
@p01arst0rm
Copy link
Owner

@Pamplemousse i'm pretty sure the command to install needs to be sudo :)

@p01arst0rm
Copy link
Owner

@Pamplemousse @Ericson2314 as NixOS#5094 has been merged, ill move the meson branch to the latest master then fix the build. should then be able to merge this too (provided no conflicts).

@Ericson2314
Copy link

@p01arst0rm I would merge this then rebase, now that all comments are addressed.

@p01arst0rm p01arst0rm merged commit 3bfbed1 into p01arst0rm:meson Aug 5, 2021
@Pamplemousse Pamplemousse deleted the meson_documentation branch August 9, 2021 17:16
Ericson2314 added a commit that referenced this pull request Apr 25, 2024
Fix and test deleting when lower store references
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants