dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
83b917a960
nixpkgs/nixos/doc/manual/from_md
History
LoveIsGrief 83b917a960
nixos/manpages: Explain -I option and how to build manpages 
When running nixos-rebuild -I, the man page just said "-I path" which could be interpreted as
 "just a path to nixpkgs", which in fact it actually has the same meaning as NIX_PATH.

This is now made clear in the manual, so that when grepping "-I" and "NIX_PATH" one quickly finds
 the format of the option.

I don't know how to link to the "nix manual" as stated in the docbook, so I left that as it is.

Additionally, it wasn't clear to me how to actually build the man pages and view the changes I made.
That's now in the contributing-to-this-manual.chapter.md.
2022-12-11 11:00:06 +01:00
..
administration treewide: change postgresql_10 in documentation and examples to postgresql_14 2022-08-15 22:36:32 +02:00
configuration nixos/manual: Don't recommend mkpasswd methods 2022-11-19 14:07:59 +01:00
development nixos/doc: document mkOrder and friends 2022-12-02 14:15:24 +01:00
installation Release NixOS 22.11 2022-11-30 11:52:38 +01:00
release-notes vim-full: rename from vim_configurable 2022-12-09 09:55:55 +01:00
contributing-to-this-manual.chapter.xml nixos/manpages: Explain -I option and how to build manpages 2022-12-11 11:00:06 +01:00
README.md

README.md

This directory is temporarily needed while we transition the manual to CommonMark. It stores the output of the ../md-to-db.sh script that converts CommonMark files back to DocBook.

We are choosing to convert the Markdown to DocBook at authoring time instead of manual building time, because we do not want the pandoc toolchain to become part of the NixOS closure.

Do not edit the DocBook files inside this directory or its subdirectories. Instead, edit the corresponding .md file in the normal manual directories, and run ../md-to-db.sh to update the file here.