commit 6c14851943fe55da9df88a502d1e1fe2271d9666 · pyrox.dev/nixpkgs

+20

.github/workflows/nixos-manual.yml

···

       1
       1
       +
       name: NixOS manual checks

     

       2
       2
       +
       

     

       3
       3
       +
       on:

     

       4
       4
       +
         pull_request:

     

       5
       5
       +
           branches-ignore:

     

       6
       6
       +
             - 'release-**'

     

       7
       7
       +
           paths:

     

       8
       8
       +
             - 'nixos/**/*.xml'

     

       9
       9
       +
             - 'nixos/**/*.md'

     

       10
       10
       +
       

     

       11
       11
       +
       jobs:

     

       12
       12
       +
         tests:

     

       13
       13
       +
           runs-on: ubuntu-latest

     

       14
       14
       +
           steps:

     

       15
       15
       +
           - uses: actions/checkout@v2

     

       16
       16
       +
           - uses: cachix/install-nix-action@v12

     

       17
       17
       +
           - name: Check DocBook files generated from Markdown are consistent

     

       18
       18
       +
             run: |

     

       19
       19
       +
               nixos/doc/manual/md-to-db.sh

     

       20
       20
       +
               git diff --exit-code

+18

nixos/doc/manual/development/building-nixos.chapter.md

···

       1
       1
       +
       # Building Your Own NixOS CD {#sec-building-cd}

     

       2
       2
       +
       Building a NixOS CD is as easy as configuring your own computer. The idea is to use another module which will replace your `configuration.nix` to configure the system that would be installed on the CD.

     

       3
       3
       +
       

     

       4
       4
       +
       Default CD/DVD configurations are available inside `nixos/modules/installer/cd-dvd`

     

       5
       5
       +
       

     

       6
       6
       +
       ```ShellSession

     

       7
       7
       +
       $ git clone https://github.com/NixOS/nixpkgs.git

     

       8
       8
       +
       $ cd nixpkgs/nixos

     

       9
       9
       +
       $ nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix default.nix

     

       10
       10
       +
       ```

     

       11
       11
       +
       

     

       12
       12
       +
       Before burning your CD/DVD, you can check the content of the image by mounting anywhere like suggested by the following command:

     

       13
       13
       +
       

     

       14
       14
       +
       ```ShellSession

     

       15
       15
       +
       # mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso</screen>

     

       16
       16
       +
       ```

     

       17
       17
       +
       

     

       18
       18
       +
       If you want to customize your NixOS CD in more detail, or generate other kinds of images, you might want to check out [nixos-generators](https://github.com/nix-community/nixos-generators). This can also be a good starting point when you want to use Nix to build a 'minimal' image that doesn't include a NixOS installation.

-33

nixos/doc/manual/development/building-nixos.xml

···

       1
       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       2
       -
               xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       3
       -
               xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       4
       -
               version="5.0"

     

       5
       5
       -
               xml:id="sec-building-cd">

     

       6
       6
       -
        <title>Building Your Own NixOS CD</title>

     

       7
       7
       -
        <para>

     

       8
       8
       -
         Building a NixOS CD is as easy as configuring your own computer. The idea is

     

       9
       9
       -
         to use another module which will replace your

     

       10
       10
       -
         <filename>configuration.nix</filename> to configure the system that would be

     

       11
       11
       -
         installed on the CD.

     

       12
       12
       -
        </para>

     

       13
       13
       -
        <para>

     

       14
       14
       -
         Default CD/DVD configurations are available inside

     

       15
       15
       -
         <filename>nixos/modules/installer/cd-dvd</filename>.

     

       16
       16
       -
       <screen>

     

       17
       17
       -
       <prompt>$ </prompt>git clone https://github.com/NixOS/nixpkgs.git

     

       18
       18
       -
       <prompt>$ </prompt>cd nixpkgs/nixos

     

       19
       19
       -
       <prompt>$ </prompt>nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix default.nix</screen>

     

       20
       20
       -
        </para>

     

       21
       21
       -
        <para>

     

       22
       22
       -
         Before burning your CD/DVD, you can check the content of the image by

     

       23
       23
       -
         mounting anywhere like suggested by the following command:

     

       24
       24
       -
       <screen>

     

       25
       25
       -
       <prompt># </prompt>mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso</screen>

     

       26
       26
       -
        </para>

     

       27
       27
       -
        <para>

     

       28
       28
       -
        If you want to customize your NixOS CD in more detail, or generate other kinds

     

       29
       29
       -
        of images, you might want to check out <link

     

       30
       30
       -
        xlink:href="https://github.com/nix-community/nixos-generators">nixos-generators</link>. This can also be a good starting point when you want to use Nix to build a

     

       31
       31
       -
        'minimal' image that doesn't include a NixOS installation.

     

       32
       32
       -
        </para>

     

       33
       33
       -
       </chapter>

+1 -1

nixos/doc/manual/development/development.xml

···

       13
       13
        
        <xi:include href="writing-modules.xml" />

     

       14
       14
        
        <xi:include href="building-parts.xml" />

     

       15
       15
        
        <xi:include href="writing-documentation.xml" />

     

       16
       16
       -
        <xi:include href="building-nixos.xml" />

     

       16
       16
       +
        <xi:include href="../from_md/development/building-nixos.chapter.xml" />

     

       17
       17
        
        <xi:include href="nixos-tests.xml" />

     

       18
       18
        
        <xi:include href="testing-installer.xml" />

     

       19
       19
        
        <xi:include href="releases.xml" />

+5

nixos/doc/manual/from_md/README.md

···

       1
       1
       +
       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.

     

       2
       2
       +
       

     

       3
       3
       +
       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.

     

       4
       4
       +
       

     

       5
       5
       +
       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.

+33

nixos/doc/manual/from_md/development/building-nixos.chapter.xml

···

       1
       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-building-cd">

     

       2
       2
       +
         <title>Building Your Own NixOS CD</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           Building a NixOS CD is as easy as configuring your own computer. The

     

       5
       5
       +
           idea is to use another module which will replace your

     

       6
       6
       +
           <literal>configuration.nix</literal> to configure the system that

     

       7
       7
       +
           would be installed on the CD.

     

       8
       8
       +
         </para>

     

       9
       9
       +
         <para>

     

       10
       10
       +
           Default CD/DVD configurations are available inside

     

       11
       11
       +
           <literal>nixos/modules/installer/cd-dvd</literal>

     

       12
       12
       +
         </para>

     

       13
       13
       +
         <programlisting>

     

       14
       14
       +
       $ git clone https://github.com/NixOS/nixpkgs.git

     

       15
       15
       +
       $ cd nixpkgs/nixos

     

       16
       16
       +
       $ nix-build -A config.system.build.isoImage -I nixos-config=modules/installer/cd-dvd/installation-cd-minimal.nix default.nix

     

       17
       17
       +
       </programlisting>

     

       18
       18
       +
         <para>

     

       19
       19
       +
           Before burning your CD/DVD, you can check the content of the image

     

       20
       20
       +
           by mounting anywhere like suggested by the following command:

     

       21
       21
       +
         </para>

     

       22
       22
       +
         <programlisting>

     

       23
       23
       +
       # mount -o loop -t iso9660 ./result/iso/cd.iso /mnt/iso&lt;/screen&gt;

     

       24
       24
       +
       </programlisting>

     

       25
       25
       +
         <para>

     

       26
       26
       +
           If you want to customize your NixOS CD in more detail, or generate

     

       27
       27
       +
           other kinds of images, you might want to check out

     

       28
       28
       +
           <link xlink:href="https://github.com/nix-community/nixos-generators">nixos-generators</link>.

     

       29
       29
       +
           This can also be a good starting point when you want to use Nix to

     

       30
       30
       +
           build a <quote>minimal</quote> image that doesn’t include a NixOS

     

       31
       31
       +
           installation.

     

       32
       32
       +
         </para>

     

       33
       33
       +
       </chapter>

+32

nixos/doc/manual/md-to-db.sh

···

       1
       1
       +
       #! /usr/bin/env nix-shell

     

       2
       2
       +
       #! nix-shell -I nixpkgs=channel:nixpkgs-unstable -i bash -p pandoc

     

       3
       3
       +
       

     

       4
       4
       +
       # This script is temporarily needed while we transition the manual to

     

       5
       5
       +
       # CommonMark. It converts the .md files in the regular manual folder

     

       6
       6
       +
       # into DocBook files in the from_md folder.

     

       7
       7
       +
       

     

       8
       8
       +
       DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

     

       9
       9
       +
       pushd $DIR

     

       10
       10
       +
       

     

       11
       11
       +
       OUT="$DIR/from_md"

     

       12
       12
       +
       mapfile -t MD_FILES < <(find . -type f -regex '.*\.md$')

     

       13
       13
       +
       

     

       14
       14
       +
       for mf in ${MD_FILES[*]}; do

     

       15
       15
       +
         mkdir -p $(dirname "$OUT/$mf")

     

       16
       16
       +
         if [ "${mf: -11}" == ".section.md" ]; then

     

       17
       17
       +
           pandoc "$mf" -t docbook \

     

       18
       18
       +
             --extract-media=media \

     

       19
       19
       +
             -f markdown+smart \

     

       20
       20
       +
           | cat  > "$OUT/${mf%".section.md"}.section.xml"

     

       21
       21
       +
         fi

     

       22
       22
       +
       

     

       23
       23
       +
         if [ "${mf: -11}" == ".chapter.md" ]; then

     

       24
       24
       +
           pandoc "$mf" -t docbook \

     

       25
       25
       +
             --top-level-division=chapter \

     

       26
       26
       +
             --extract-media=media \

     

       27
       27
       +
             -f markdown+smart \

     

       28
       28
       +
           | cat  > "$OUT/${mf%".chapter.md"}.chapter.xml"

     

       29
       29
       +
         fi

     

       30
       30
       +
       done

     

       31
       31
       +
       

     

       32
       32
       +
       popd