summaryrefslogtreecommitdiffstats
path: root/docs/CODE_QUALITY.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* docs: fix formatting a bitDmitry V. Levin2023-01-231-1/+1
|
* doc: drop remaining references to LGTM.comYu Watanabe2022-09-231-3/+3
|
* docs: update OSS-Fuzz linksEvgeny Vereshchagin2022-05-261-2/+5
|
* docs: use relative linksBenjamin Franzke2022-05-181-1/+1
| | | | | | | | | | | | | | | | Allows for links to work both on systemd.io (or forks) and when viewed on https://github.com/systemd/systemd/tree/main/docs Note that the markdown links are converted by jekyll-relative-links[1] to html. This plugin is enabled by default on github pages[2][3]. Due to a bug in jekyll-relative-links – see https://github.com/benbalter/jekyll-relative-links/issues/61 – we need to avoid line-wrapped links when using relative markdown links. [1] https://github.com/benbalter/jekyll-relative-links [2] https://github.blog/2016-12-05-relative-links-for-github-pages/ [3] https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins
* docs: stop recommending meson compileZbigniew Jędrzejewski-Szmek2022-04-121-8/+9
| | | | | | | | | | | | | | | | | | With meson-0.60, meson compile stopped working with some targets: $ meson compile -C build update-man-rules ERROR: Can't invoke target `update-man-rules`: ambiguous name. Add target type and/or path: `PATH/NAME:TYPE` This is obviously a regression in meson, but based on a chat with the maintainers, it seems that there's some disagreement as to whether 'meson compile' is useful and how exactly it should work. Since we're already at meson 0.60.3 and this hasn't been fixed, and people generally don't seem to consider this an issue, let's return to documenting the usual practice of 'ninja -C build' that just works everywhere. (Since nobody has raised any fuss in systemd, it means that people are generally using the shorter form during development too. I only noticed because I pasted a command from the release docs when preparing -rc1.)
* docs: update branch namesZbigniew Jędrzejewski-Szmek2022-01-031-4/+4
| | | | | Also use --atomic when pushing multiple items with git; adjust some external URLs.
* docs: add spdx tags to all .md filesZbigniew Jędrzejewski-Szmek2021-09-271-0/+1
| | | | | | I have no idea if this is going to cause rendering problems, and it is fairly hard to check. So let's just merge this, and if it github markdown processor doesn't like it, revert.
* meson: rename target to update-hwdbZbigniew Jędrzejewski-Szmek2021-01-271-1/+1
| | | | | The goal is to have all "update-*" targets named uniformly so that tab-completion works. The script is renamed to match.
* meson: rename target to update-man-rulesZbigniew Jędrzejewski-Szmek2021-01-271-1/+1
| | | | Same justification as for update-dbus-docs.
* tree-wide: suggest meson command lines instead of ninja onesLennart Poettering2020-12-171-8/+10
| | | | | | | This only changes documentation. In various places we call "ninja" directly. I figured it would be safer to leave those in place for now, given the meson replacement commands lines appears to be supported in newer meson versions only.
* docs: add a link to the Fossies codespell reportEvgeny Vereshchagin2020-05-211-0/+3
|
* docs: make it prettyTobias Bernard2019-12-111-0/+1
| | | | | | | Add custom Jekyll theme, logo, webfont and .gitignore FIXME: the markdown files have some H1 headers which need to be replaced with H2
* docs: place all our markdown docs in rough categoriesLennart Poettering2019-12-111-0/+1
|
* docs: add documentation for sanitizersFrantisek Sumsal2019-05-271-0/+5
|
* docs: add a "front matter" snippet to our markdown pagesFilipe Brandenburger2019-01-021-0/+4
| | | | | | | | | | | | | | | | 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.
* docs: turn LGTM URL into a markdown linkFilipe Brandenburger2018-11-301-2/+2
|
* docs: move doc/ to docs/Filipe Brandenburger2018-09-081-0/+64
The docs/ directory is special in GitHub, since it can be used to serve GitHub Pages from, so there's a benefit to switching to it in order to expose it directly as a website. Updated references to it from the documentations themselves, from the CONTRIBUTING.md file and from Meson build files.