dan/liminix
1
0
Fork 5
Code

fix refs and raise heading levels in generated hardware doc

Browse Source
This commit is contained in:
Daniel Barlow 2025-04-06 23:46:24 +01:00
parent 9f501018bf
commit 9bc9a077e3
4 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Makefile
View File

@ -12,6 +12,8 @@ DOCS=\
hardware.adoc: hardware.nix hardware.adoc: hardware.nix
pandoc -f rst -t asciidoc -o $@ hardware.rst pandoc -f rst -t asciidoc -o $@ hardware.rst
# don't even ask
sed -E -i.bak -e 's/^=(=*) /\1 /g' hardware.adoc
html: Makefile $(patsubst %,%.adoc,$(DOCS)) html: Makefile $(patsubst %,%.adoc,$(DOCS))
asciidoctor -D _build -d book index.adoc asciidoctor -D _build -d book index.adoc

2
doc/admin.adoc
View File

@ -4,7 +4,7 @@
Liminix services are built on s6-rc, which is itself layered on s6. Liminix services are built on s6-rc, which is itself layered on s6.
Services are defined at build time in your configuration (see Services are defined at build time in your configuration (see
`+configuration-services+` for information) and can't be added <<_services>> for information) and can't be added
to/changed at runtime, but to monitor events or diagnose problems you to/changed at runtime, but to monitor events or diagnose problems you
may need to inspect them on the running system. Here are some of the may need to inspect them on the running system. Here are some of the
most commonly used s6,-rc commands: most commonly used s6,-rc commands:

2
doc/installation.adoc
View File

@ -25,7 +25,7 @@ deploy onto, sometimes due to differences in the uses these devices are
put to. put to.
For a more full description of how to configure Liminix, see For a more full description of how to configure Liminix, see
`+configuration+`. Assuming for the moment that you want a typical home <<_configuration>>. Assuming for the moment that you want a typical home
wireless gateway/router, the best way to get started is to copy wireless gateway/router, the best way to get started is to copy
`+examples/rotuer.nix+` and edit it for your requirements. `+examples/rotuer.nix+` and edit it for your requirements.

6
doc/tutorial.adoc
View File

@ -138,10 +138,10 @@ device also _ought_ to work here, but you accept the slightly greater
bricking risk if it doesn't. bricking risk if it doesn't.
==== ====
See `+hardware+` for device support status. See <<_supported_hardware>> for device support status.
You may want to read and inwardly digest the Develoment Manual section You may want to read and inwardly digest the section about <<serial>>
`+serial+` when you start working with Liminix on real hardware. You connections when you start working with Liminix on real hardware. You
won't _need_ serial access for this example, assuming it works, but it won't _need_ serial access for this example, assuming it works, but it
allows you to see the boot monitor and kernel messages, and to login allows you to see the boot monitor and kernel messages, and to login
directly to the device if for some reason it doesn't bring its network directly to the device if for some reason it doesn't bring its network