Commit graph

64 commits

Author SHA1 Message Date
Daniel Barlow
b3a7a2246d tutorial: move the warning nearer to the decision point 2023-09-17 21:53:15 +01:00
Daniel Barlow
6674344021 don't end chapter with ellipsis 2023-09-17 21:47:09 +01:00
Daniel Barlow
c81ee62374 doc: proofread admin section, add link to TFTP 2023-09-17 21:44:32 +01:00
Daniel Barlow
dd0b1734c1 how to write a module 2023-09-17 21:32:22 +01:00
Daniel Barlow
0a2588013a include generated module options 2023-09-17 17:47:04 +01:00
Daniel Barlow
71b583a756 copy "how to flash" from the old docs 2023-09-17 17:36:02 +01:00
Daniel Barlow
e72d78ab64 restore intro 2023-09-17 17:03:56 +01:00
Daniel Barlow
17035ca3b7 outline of the missing doc sections 2023-09-17 17:03:56 +01:00
Daniel Barlow
dece70b336 link to ADR 2023-09-17 17:03:56 +01:00
Daniel Barlow
50ea144dec mention service dependencies 2023-09-17 17:03:56 +01:00
Daniel Barlow
fc84435985 improve syntax blah 2023-09-17 17:03:56 +01:00
Daniel Barlow
06b725cb77 document the module-based-services decision 2023-09-17 17:03:56 +01:00
Daniel Barlow
c74543c4ff doc: how to define an s6 service 2023-09-17 17:03:56 +01:00
Daniel Barlow
54526c1e11 start writing configuration guide 2023-09-17 17:03:56 +01:00
Daniel Barlow
f81aa54444 rename file 2023-09-17 17:03:56 +01:00
Daniel Barlow
56261f77b0 add example with real hardware 2023-09-17 17:03:56 +01:00
Daniel Barlow
8600dfc8cf proofread v2 2023-09-17 17:03:56 +01:00
Daniel Barlow
bb280c6d97 rename qemu example 2023-09-17 17:03:56 +01:00
Daniel Barlow
b7e805c97f connecting a client to hellonet 2023-09-17 17:03:56 +01:00
Daniel Barlow
9223fa7ec4 first proofreading pass 2023-09-17 17:03:56 +01:00
Daniel Barlow
0f31afee2b hellonet: set password for root
otherwise incoming ssh gets a bit fraught
2023-09-17 17:03:56 +01:00
Daniel Barlow
c6faf88dd1 doc WIP: build "hello net" example 2023-09-17 17:03:56 +01:00
Daniel Barlow
625146d821 escape backslash in service type 2023-08-16 22:26:40 +01:00
Daniel Barlow
bd908307c4 print module pathname if it contains services
so that the user knows what to add to their imports
2023-08-16 22:26:40 +01:00
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