Commit graph

40 commits

Author SHA1 Message Date
Daniel Barlow
d7785d9d75 if no preamble, print module pathname as headline
this was supposed to work already but was broken
2023-08-16 22:26:40 +01:00
Daniel Barlow
519de0b55c module docs: service modules are listed after plain modules 2023-08-12 20:10:40 +01:00
Daniel Barlow
f20d1cfc01 print description only if present 2023-08-12 18:16:20 +01:00
Daniel Barlow
e039783e67 exclude outputs from doc 2023-08-12 18:16:06 +01:00
Daniel Barlow
dc4b7ebffd module docs: print examples 2023-08-11 21:12:57 +01:00
Daniel Barlow
3669a4000f explain (badly) the module/service dynamic 2023-08-09 22:27:18 +01:00
Daniel Barlow
f7b507587d print modules in consistent (alphabetical) order 2023-08-09 22:26:50 +01:00
Daniel Barlow
be044cb59e doc: print headline for modules with no preamble 2023-08-07 23:08:41 +01:00
Daniel Barlow
615c2de537 extract module top-level comment to docs 2023-08-07 22:14:58 +01:00
Daniel Barlow
59a41a712b fix underline 2023-08-06 22:26:00 +01:00
Daniel Barlow
f3e32115ee extremely hacky first pass at autogenerated module docs 2023-08-06 22:25:37 +01:00
Daniel Barlow
0f57ae2a32 fix section order 2023-07-09 15:18:19 +01:00
Daniel Barlow
2d05695d99 add cautionary note about flashing from openwrt
h/t matthewcroughan, thank you for your service
2023-07-09 15:12:18 +01:00
Daniel Barlow
a1dff5b92d document flash.scr 2023-07-08 23:43:15 +01:00
Daniel Barlow
943820d4dd add doc note about finding supported devices 2023-06-22 10:06:40 +01:00
Daniel Barlow
3f6585f6be mention min-copy-closure 2023-05-22 00:27:41 +01:00
Daniel Barlow
e83b33686f typo 2023-05-22 00:20:52 +01:00
Daniel Barlow
35a5605266 improve(?) markup 2023-05-22 00:14:32 +01:00
Daniel Barlow
4429f2b177 grammar 2023-05-21 23:48:10 +01:00
Daniel Barlow
43fa9f0679 link to OpenWrt serial console docs 2023-05-21 23:41:42 +01:00
Daniel Barlow
805c2f7984 update CoC 2023-05-21 23:31:28 +01:00
Daniel Barlow
648ac2eb7f Document jffs2, min-copy-closure, liminix-rebuild
Some of the code is now out of date w.r.t. some of the text
2023-05-17 15:38:22 +01:00
Daniel Barlow
b0a0fdcfcc add "standard" module, which includes flashimage kexec & jffs2
most systems need most of these, so it makes writing the docs a
lot easier
2023-05-17 15:38:22 +01:00
Daniel Barlow
6184148dfd add example host config for bordervm ethernet 2023-05-10 21:38:46 +01:00
Daniel Barlow
b70c8ee258 support USB ethernet in bordervm 2023-05-09 22:58:56 +01:00
Daniel Barlow
0687ae7f5c rename flashable->flashimage, o.squashfs to rootfs
"rootfs" describes what it is for, "squashfs" merely says
how it's implemented

(also, rootfs-as-jffs2 will soon be added)
2023-04-10 18:13:27 +01:00
Daniel Barlow
a5630c1f30 add cautionary note about flashing a running device 2023-03-26 10:21:36 +01:00
Daniel Barlow
608d750b60 describe how to flash Liminix, and kexecboot 2023-03-24 23:39:06 +00:00
Daniel Barlow
ce05f4e44c extract phram.mtd ramdisk support from tftpboot module
also rename tftproot output to tftpboot for consistency
2023-03-18 14:30:10 +00:00
Daniel Barlow
23b434b80e add a logo 2023-03-18 14:30:10 +00:00
Daniel Barlow
0cab6e9fba rename phram -> tftpboot and flash.scr to boot.scr 2023-03-02 15:11:12 +00:00
Daniel Barlow
423f8aa6d3 add another link I've previously found useful 2023-02-19 18:14:27 +00:00
Daniel Barlow
c7a65625fa fix markup 2023-02-19 18:14:27 +00:00
Daniel Barlow
bf68127dc4 explain ppoe-l2tp better
though not much better, to be honest
2023-02-17 20:57:05 +00:00
Daniel Barlow
db70623bff improve markup 2023-02-17 20:54:18 +00:00
Daniel Barlow
0777bb47c0 simplify calling buildEnv 2023-02-17 20:41:55 +00:00
Daniel Barlow
37caac1d56 add shell.nix and tidy docs to take advantage of it 2023-02-17 20:19:45 +00:00
Daniel Barlow
832221748b explain bordervm 2023-02-17 20:03:57 +00:00
Daniel Barlow
40739d780b convert docs to restructuredText 2023-02-16 22:06:50 +00:00
Daniel Barlow
8915f828a5 empty doc folder 2023-02-15 23:26:22 +00:00