diff options
| author | Benjamin Franzke <benjaminfranzke@googlemail.com> | 2022-05-18 00:05:38 +0200 |
|---|---|---|
| committer | Benjamin Franzke <benjaminfranzke@googlemail.com> | 2022-05-18 20:34:10 +0200 |
| commit | 5c90c67a344e05368570367009768cb058a3046d (patch) | |
| tree | 9a87d3f0d96db5627161b059a8551263d6b9d39b /docs/JOURNAL_FILE_FORMAT.md | |
| parent | e4885958dc36080aabbe7efae4348390ff743382 (diff) | |
| download | systemd-5c90c67a344e05368570367009768cb058a3046d.tar.gz | |
docs: use relative links
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
Diffstat (limited to 'docs/JOURNAL_FILE_FORMAT.md')
| -rw-r--r-- | docs/JOURNAL_FILE_FORMAT.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/JOURNAL_FILE_FORMAT.md b/docs/JOURNAL_FILE_FORMAT.md index 0036ee45d6..61a27a9699 100644 --- a/docs/JOURNAL_FILE_FORMAT.md +++ b/docs/JOURNAL_FILE_FORMAT.md @@ -8,8 +8,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later # Journal File Format _Note that this document describes the binary on-disk format of journals only. -For interfacing with web technologies there's the [Journal JSON Format](https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format). -For transfer of journal data across the network there's the [Journal Export Format](https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format)._ +For interfacing with web technologies there's the [Journal JSON Format](JOURNAL_EXPORT_FORMATS.md#journal-json-format). +For transfer of journal data across the network there's the [Journal Export Format](JOURNAL_EXPORT_FORMATS.md#journal-export-format)._ The systemd journal stores log data in a binary format with several features: @@ -45,9 +45,10 @@ stream-based nature it is not indexed. _Or, to put this in other words: this low-level document is probably not what you want to use as base of your project. You want our [C API](https://www.freedesktop.org/software/systemd/man/sd-journal.html) instead! -And if you really don't want the C API, then you want the [Journal Export -Format or Journal JSON Format](https://systemd.io/JOURNAL_EXPORT_FORMATS) instead! -This document is primarily for your entertainment and education. Thank you!_ +And if you really don't want the C API, then you want the +[Journal Export Format or Journal JSON Format](JOURNAL_EXPORT_FORMATS.md) +instead! This document is primarily for your entertainment and education. +Thank you!_ This document assumes you have a basic understanding of the journal concepts, the properties of a journal entry and so on. If not, please go and read up, |