diff options
| author | eldritch horrors <pennae@lix.systems> | 2024-03-04 07:12:09 +0100 |
|---|---|---|
| committer | eldritch horrors <pennae@lix.systems> | 2024-03-04 07:12:09 +0100 |
| commit | 116e48fad3bf91ffd179c048cd0444de5a65719f (patch) | |
| tree | ffcfee95aa6e96927566cadd5a0c7ca9d9aec8fe /doc | |
| parent | 2ba978800355189e263aa7fe13277fd62ce743bc (diff) | |
Merge pull request #9573 from hercules-ci/rl-next-md-frontmatter
rl-next: Fix and support markdown frontmatter syntax
(cherry picked from commit 69b7876a0810269ad71807594cfd99b26cd8a5ff)
Change-Id: I8bfb8967af0943080fdd70d257c34abaf0a9fedf
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/rl-next/nix-env-json-drv-path.md | 9 | ||||
| -rw-r--r-- | doc/manual/rl-next/source-positions-in-errors.md | 9 | ||||
| -rw-r--r-- | doc/manual/src/contributing/hacking.md | 9 |
3 files changed, 11 insertions, 16 deletions
diff --git a/doc/manual/rl-next/nix-env-json-drv-path.md b/doc/manual/rl-next/nix-env-json-drv-path.md index fbe2b67d8..734cefd1b 100644 --- a/doc/manual/rl-next/nix-env-json-drv-path.md +++ b/doc/manual/rl-next/nix-env-json-drv-path.md @@ -1,9 +1,6 @@ +--- synopsis: Fix `nix-env --query --drv-path --json` -prs: #9257 -description: { +prs: 9257 +--- Fixed a bug where `nix-env --query` ignored `--drv-path` when `--json` was set. - -} - - diff --git a/doc/manual/rl-next/source-positions-in-errors.md b/doc/manual/rl-next/source-positions-in-errors.md index 15df884ea..5b210289d 100644 --- a/doc/manual/rl-next/source-positions-in-errors.md +++ b/doc/manual/rl-next/source-positions-in-errors.md @@ -1,7 +1,8 @@ +--- synopsis: Source locations are printed more consistently in errors -issues: #561 -prs: #9555 -description: { +issues: 561 +prs: 9555 +--- Source location information is now included in error messages more consistently. Given this code: @@ -39,5 +40,3 @@ error: error: value is a set while a string was expected ``` - -} diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md index 6bea6f727..a3cf05327 100644 --- a/doc/manual/src/contributing/hacking.md +++ b/doc/manual/src/contributing/hacking.md @@ -322,17 +322,16 @@ User-visible changes should come with a release note. Here's what a complete entry looks like. The file name is not incorporated in the document. ``` +--- synopsis: Basically a title -issues: #1234 -prs: #1238 -description: { +issues: 1234 +prs: 1238 +--- Here's one or more paragraphs that describe the change. - It's markdown - Add references to the manual using @docroot@ - -} ``` Significant changes should add the following header, which moves them to the top. |