Skip to content

Commit b4532ef

Browse files
**/README.md: one sentence per line
As documented in doc/README.md.
1 parent 2369d96 commit b4532ef

File tree

13 files changed

+393
-363
lines changed

13 files changed

+393
-363
lines changed

CONTRIBUTING.md

Lines changed: 71 additions & 53 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 20 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@
1313
<a href="https://opencollective.com/nixos"><img src="https://opencollective.com/nixos/tiers/supporter/badge.svg?label=supporters&color=brightgreen" alt="Open Collective supporters" /></a>
1414
</p>
1515

16-
[Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over
17-
120,000 software packages that can be installed with the
18-
[Nix](https://nixos.org/nix/) package manager. It also implements
19-
[NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
16+
[Nixpkgs](https://github.com/nixos/nixpkgs) is a collection of over 120,000 software packages that can be installed with the [Nix](https://nixos.org/nix/) package manager.
17+
It also implements [NixOS](https://nixos.org/nixos/), a purely-functional Linux distribution.
2018

2119
# Manuals
2220

@@ -34,9 +32,8 @@
3432

3533
# Other Project Repositories
3634

37-
The sources of all official Nix-related projects are in the [NixOS
38-
organization on GitHub](https://github.com/NixOS/). Here are some of
39-
the main ones:
35+
The sources of all official Nix-related projects are in the [NixOS organization on GitHub](https://github.com/NixOS/).
36+
Here are some of the main ones:
4037

4138
* [Nix](https://github.com/NixOS/nix) - the purely functional package manager
4239
* [NixOps](https://github.com/NixOS/nixops) - the tool to remotely deploy NixOS machines
@@ -48,54 +45,41 @@ the main ones:
4845

4946
# Continuous Integration and Distribution
5047

51-
Nixpkgs and NixOS are built and tested by our continuous integration
52-
system, [Hydra](https://hydra.nixos.org/).
48+
Nixpkgs and NixOS are built and tested by our continuous integration system, [Hydra](https://hydra.nixos.org/).
5349

5450
* [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)
5551
* [Continuous package builds for the NixOS 25.05 release](https://hydra.nixos.org/jobset/nixos/release-25.05)
5652
* [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)
5753
* [Tests for the NixOS 25.05 release](https://hydra.nixos.org/job/nixos/release-25.05/tested#tabs-constituents)
5854

59-
Artifacts successfully built with Hydra are published to cache at
60-
https://cache.nixos.org/. When successful build and test criteria are
61-
met, the Nixpkgs expressions are distributed via [Nix
62-
channels](https://nix.dev/manual/nix/stable/command-ref/nix-channel.html).
55+
Artifacts successfully built with Hydra are published to cache at https://cache.nixos.org/.
56+
When successful build and test criteria are met, the Nixpkgs expressions are distributed via [Nix channels](https://nix.dev/manual/nix/stable/command-ref/nix-channel.html).
6357

6458
# Contributing
6559

66-
Nixpkgs is among the most active projects on GitHub. While thousands
67-
of open issues and pull requests might seem a lot at first, it helps
68-
consider it in the context of the scope of the project. Nixpkgs
69-
describes how to build tens of thousands of pieces of software and implements a
70-
Linux distribution. The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse)
71-
page gives a sense of the project activity.
60+
Nixpkgs is among the most active projects on GitHub.
61+
While thousands of open issues and pull requests might seem a lot at first, it helps consider it in the context of the scope of the project.
62+
Nixpkgs describes how to build tens of thousands of pieces of software and implements a Linux distribution.
63+
The [GitHub Insights](https://github.com/NixOS/nixpkgs/pulse) page gives a sense of the project activity.
7264

73-
Community contributions are always welcome through GitHub Issues and
74-
Pull Requests.
65+
Community contributions are always welcome through GitHub Issues and Pull Requests.
7566

76-
For more information about contributing to the project, please visit
77-
the [contributing page](CONTRIBUTING.md).
67+
For more information about contributing to the project, please visit the [contributing page](CONTRIBUTING.md).
7868

7969
# Donations
8070

81-
The infrastructure for NixOS and related projects is maintained by a
82-
nonprofit organization, the [NixOS
83-
Foundation](https://nixos.org/nixos/foundation.html). To ensure the
84-
continuity and expansion of the NixOS infrastructure, we are looking
85-
for donations to our organization.
71+
The infrastructure for NixOS and related projects is maintained by a nonprofit organization, the [NixOS Foundation](https://nixos.org/nixos/foundation.html).
72+
To ensure the continuity and expansion of the NixOS infrastructure, we are looking for donations to our organization.
8673

87-
You can donate to the NixOS foundation through [SEPA bank
88-
transfers](https://nixos.org/donate.html) or by using Open Collective:
74+
You can donate to the NixOS foundation through [SEPA bank transfers](https://nixos.org/donate.html) or by using Open Collective:
8975

9076
<a href="https://opencollective.com/nixos#support"><img src="https://opencollective.com/nixos/tiers/supporter.svg?width=890" /></a>
9177

9278
# License
9379

9480
Nixpkgs is licensed under the [MIT License](COPYING).
9581

96-
Note: MIT license does not apply to the packages built by Nixpkgs,
97-
merely to the files in this repository (the Nix expressions, build
98-
scripts, NixOS modules, etc.). It also might not apply to patches
99-
included in Nixpkgs, which may be derivative works of the packages to
100-
which they apply. The aforementioned artifacts are all covered by the
101-
licenses of the respective packages.
82+
Note:
83+
MIT license does not apply to the packages built by Nixpkgs, merely to the files in this repository (the Nix expressions, build scripts, NixOS modules, etc.).
84+
It also might not apply to patches included in Nixpkgs, which may be derivative works of the packages to which they apply.
85+
The aforementioned artifacts are all covered by the licenses of the respective packages.

doc/README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,24 @@ Use [`devmode`](../pkgs/by-name/de/devmode/README.md) for a live preview when ed
6262

6363
Once you have a successful build, you can open the relevant HTML (path mentioned above) in a browser along with the anchor, and observe the redirection.
6464

65-
Note that if you already loaded the page and *then* input the anchor, you will need to perform a reload. This is because browsers do not re-run client JS code when only the anchor has changed.
65+
Note that if you already loaded the page and *then* input the anchor, you will need to perform a reload.
66+
This is because browsers do not re-run client JS code when only the anchor has changed.
6667

6768
## Syntax
6869

6970
As per [RFC 0072](https://github.com/NixOS/rfcs/pull/72), all new documentation content should be written in [CommonMark](https://commonmark.org/) Markdown dialect.
7071

71-
Additional syntax extensions are available, all of which can be used in NixOS option documentation. The following extensions are currently used:
72+
Additional syntax extensions are available, all of which can be used in NixOS option documentation.
73+
The following extensions are currently used:
7274

7375
#### Tables
7476

7577
Tables, using the [GitHub-flavored Markdown syntax](https://github.github.com/gfm/#tables-extension-).
7678

7779
#### Anchors
7880

79-
Explicitly defined **anchors** on headings, to allow linking to sections. These should be always used, to ensure the anchors can be linked even when the heading text changes, and to prevent conflicts between [automatically assigned identifiers](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/auto_identifiers.md).
81+
Explicitly defined **anchors** on headings, to allow linking to sections.
82+
These should be always used, to ensure the anchors can be linked even when the heading text changes, and to prevent conflicts between [automatically assigned identifiers](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/auto_identifiers.md).
8083

8184
It uses the widely compatible [header attributes](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/attributes.md) syntax:
8285

@@ -99,18 +102,21 @@ They are defined using a hybrid of the link syntax with the attributes syntax kn
99102

100103
#### Automatic links
101104

102-
If you **omit a link text** for a link pointing to a section, the text will be substituted automatically. For example `[](#chap-contributing)`.
105+
If you **omit a link text** for a link pointing to a section, the text will be substituted automatically.
106+
For example `[](#chap-contributing)`.
103107

104108
This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing).
105109

106110

107111
#### HTML
108112

109-
Inlining HTML is not allowed. Parts of the documentation gets rendered to various non-HTML formats, such as man pages in the case of NixOS manual.
113+
Inlining HTML is not allowed.
114+
Parts of the documentation gets rendered to various non-HTML formats, such as man pages in the case of NixOS manual.
110115

111116
#### Roles
112117

113-
If you want to link to a man page, you can use `` {manpage}`nix.conf(5)` ``. The references will turn into links when a mapping exists in [`doc/manpage-urls.json`](./manpage-urls.json).
118+
If you want to link to a man page, you can use `` {manpage}`nix.conf(5)` ``.
119+
The references will turn into links when a mapping exists in [`doc/manpage-urls.json`](./manpage-urls.json).
114120
Please keep the `manpage-urls.json` file alphabetically sorted.
115121

116122
A few markups for other kinds of literals are also available:
@@ -123,7 +129,8 @@ A few markups for other kinds of literals are also available:
123129

124130
These literal kinds are used mostly in NixOS option documentation.
125131

126-
This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point). Though, the feature originates from [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage) with slightly different syntax.
132+
This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point).
133+
Though, the feature originates from [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage) with slightly different syntax.
127134
They are handled by `myst_role` defined per renderer. <!-- reverse references in code -->
128135

129136
#### Admonitions
@@ -326,8 +333,11 @@ Otherwise, just describe the single argument or start the arguments' definition
326333

327334
Checklist:
328335
- Start with a synopsis, to show the order of positional arguments.
329-
- Metavariables are in emphasized code spans: ``` *`arg1`* ```. Metavariables are placeholders where users may write arbitrary expressions. This includes positional arguments.
330-
- Attribute names are regular code spans: ``` `attr1` ```. These identifiers can _not_ be picked freely by users, so they are _not_ metavariables.
336+
- Metavariables are in emphasized code spans: ``` *`arg1`* ```.
337+
Metavariables are placeholders where users may write arbitrary expressions.
338+
This includes positional arguments.
339+
- Attribute names are regular code spans: ``` `attr1` ```.
340+
These identifiers can _not_ be picked freely by users, so they are _not_ metavariables.
331341
- _optional_ attributes have a _`Default:`_ if it's easily described as a value.
332342
- _optional_ attributes have a _`Default behavior:`_ if it's not easily described using a value.
333343
- Nix types aren't in code spans, because they are not code
@@ -404,7 +414,8 @@ This syntax is taken from [CommonMark](https://spec.commonmark.org/0.30/#link-re
404414

405415
#### Typographic replacements
406416

407-
Typographic replacements are enabled. Check the [list of possible replacement patterns check](https://github.com/executablebooks/markdown-it-py/blob/3613e8016ecafe21709471ee0032a90a4157c2d1/markdown_it/rules_core/replacements.py#L1-L15).
417+
Typographic replacements are enabled.
418+
Check the [list of possible replacement patterns check](https://github.com/executablebooks/markdown-it-py/blob/3613e8016ecafe21709471ee0032a90a4157c2d1/markdown_it/rules_core/replacements.py#L1-L15).
408419

409420
## Getting help
410421

lib/deprecated/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
Do not add any new functions to this directory.
55

66
This directory contains the `lib.misc` sublibrary, which - as a location - is deprecated.
7-
Furthermore, some of the functions inside are of *dubious* utility, and should perhaps be avoided,
8-
while some functions *may still be needed*.
7+
Furthermore, some of the functions inside are of *dubious* utility, and should perhaps be avoided, while some functions *may still be needed*.
98

109
This directory does not play a role in the deprecation process for library functions.
1110
They should be deprecated in place, by putting a `lib.warn` or `lib.warnIf` call around the function.

lib/fileset/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ Meanwhile `intersection ./foo ./bar` returns the empty file set without a base p
166166

167167
Arguments:
168168
- Alternative: Use the common prefix of all base paths as the resulting base path
169-
- (-) This is unnecessarily strict, because the purpose of the base path is to track the directory under which files _could_ be in the file set. It should be as long as possible.
169+
- (-) This is unnecessarily strict, because the purpose of the base path is to track the directory under which files _could_ be in the file set.
170+
It should be as long as possible.
170171
All files contained in `intersection ./foo ./foo/bar` will be under `./foo/bar` (never just under `./foo`), and `intersection ./foo ./bar` will never contain any files (never under `./.`).
171172
This would lead to `toSource` having to unexpectedly throw errors for cases such as `toSource { root = ./foo; fileset = intersect ./foo base; }`, where `base` may be `./bar` or `./.`.
172173
- (-) There is no benefit to the user, since base path is not directly exposed in the interface
@@ -263,5 +264,6 @@ Coercing paths that don't exist to file sets always gives an error.
263264
- (+) This is dangerous, because you wouldn't be protected against typos anymore.
264265
E.g. when trying to prevent `./secret` from being imported, a typo like `difference ./. ./sercet` would import it regardless.
265266
- (+) `difference ./. (maybeMissing ./does-not-exist)` can be used to do this more explicitly.
266-
- (+) `difference ./. (difference ./foo ./foo/bar)` should report an error when `./foo/bar` does not exist ("double negation"). Unfortunately, the current internal representation does not lend itself to a behavior where both `difference x ./does-not-exists` and double negation are handled and checked correctly.
267+
- (+) `difference ./. (difference ./foo ./foo/bar)` should report an error when `./foo/bar` does not exist ("double negation").
268+
Unfortunately, the current internal representation does not lend itself to a behavior where both `difference x ./does-not-exists` and double negation are handled and checked correctly.
267269
This could be fixed, but would require significant changes to the internal representation that are not worth the effort and the risk of introducing implicit behavior.

0 commit comments

Comments
 (0)