Lennart Poettering
ff2c2d0850
docs: make sure there's only one # markdown header in each file
...
@bertob wants us to be strict here, and only have one "#" header per
markdown file, and use "##" (or "###", …) for all others. Interestingly,
we mostly got this right already, but this fixes a few cases where this
wasn't correct.
2019-12-13 11:56:08 +01:00
Tobias Bernard
b41a3f66c9
docs: make it pretty
...
Add custom Jekyll theme, logo, webfont and .gitignore
FIXME: the markdown files have some H1 headers which need to be replaced
with H2
2019-12-11 17:04:20 +01:00
Lennart Poettering
4cdca0af11
docs: place all our markdown docs in rough categories
2019-12-11 10:53:00 +01:00
Simon Schricker
2d1b928109
docs: fix typo
2019-07-30 08:44:05 +02:00
Michael Prokop
d238709c14
docs: fix typos and duplicate words
...
s/and and/and/
s/explicity/explicitly/
s/that that/that/
s/the the/the/
s/is is/it is/
s/overriden/overridden/
2019-06-27 10:43:21 +02:00
Lennart Poettering
b5bd7a29f9
some CODING_STYLE additions
2019-06-25 10:56:15 +02:00
Lennart Poettering
b4f12824a0
CODING_STYLE: rename "Others" section to "Code Organization and Semantics"
...
This is a bit of a grabbag, but it's the best I could come up with
without having lots of single-item sections.
2019-04-12 17:01:05 +02:00
Lennart Poettering
4467d39315
CODING_STYLE: split out section about runtime behaviour
2019-04-12 16:59:48 +02:00
Lennart Poettering
78e5b4d7ee
CODING_STYLE: add section about C constructs use
2019-04-12 16:53:27 +02:00
Lennart Poettering
3b75e079a8
CODING_STYLE: split out section about deadlocks
2019-04-12 16:50:24 +02:00
Lennart Poettering
96f6cfbf62
CODING_STYLE: split out section about logging
2019-04-12 16:49:02 +02:00
Lennart Poettering
5638076135
CODING_STYLE: export section about exporting symbols
2019-04-12 16:45:03 +02:00
Lennart Poettering
c159efe341
CODING_STYLE: split out section about destructors
2019-04-12 16:42:44 +02:00
Lennart Poettering
996f119d97
CODING_STYLE: split out section about command line parsing
2019-04-12 16:40:34 +02:00
Lennart Poettering
b065e1f176
CODING_STYLE: Split out section about error handling
2019-04-12 16:38:14 +02:00
Lennart Poettering
831781b9c9
CODING_STYLE: split out section about commiting to git
2019-04-12 16:35:17 +02:00
Lennart Poettering
25553cd9cd
CODING_STYLE: split out section about file descriptors
2019-04-12 16:34:01 +02:00
Lennart Poettering
0485824030
CODING_STYLE: split out section about memory allocations
2019-04-12 16:31:58 +02:00
Lennart Poettering
f42c1cd4b5
CODING_STYLE: move out section about Types
2019-04-12 16:28:35 +02:00
Lennart Poettering
971dfffab8
CODING_STYLE: add section about how to reference specific concepts
2019-04-12 16:28:35 +02:00
Lennart Poettering
8c9289e705
CODING_STYLE: split out bits about Formatting into its own section
...
(And, for now, add a section "Other" to separate the rest of the stuff)
2019-04-12 16:28:35 +02:00
Lennart Poettering
2d0dce2afe
CODING_STYLE: add a section about functions not to use
...
Let's add sections to the document. First off, let's add one about
functions not to use.
2019-04-12 16:28:02 +02:00
Zbigniew Jędrzejewski-Szmek
3b69b18fbf
CODING_STYLE: adjust indentation rules, and add note about config loading
2019-04-12 08:37:41 +02:00
Chris Morin
f36712b7c3
CODING_STYLE: fix grammar mistake
2019-01-17 12:37:40 +01:00
Filipe Brandenburger
c3e270f4ee
docs: add a "front matter" snippet to our markdown pages
...
It turns out Jekyll (the engine behind GitHub Pages) requires that pages
include a "Front Matter" snippet of YAML at the top for proper rendering.
Omitting it will still render the pages, but including it opens up new
possibilities, such as using a {% for %} loop to generate index.md instead of
requiring a separate script.
I'm hoping this will also fix the issue with some of the pages (notably
CODE_OF_CONDUCT.html) not being available under systemd.io
Tested locally by rendering the website with Jekyll. Before this change, the
*.md files were kept unchanged (so not sure how that even works?!), after this
commit, proper *.html files were generated from it.
2019-01-02 14:16:34 -08:00
