| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
this converts meta.doc into an md pointer, not an xml pointer. since we
no longer need xml for manual chapters we can also remove support for
manual chapters from md-to-db.sh
since pandoc converts smart quotes to docbook quote elements and our
nixos-render-docs does not we lose this distinction in the rendered
output. that's probably not that bad, our stylesheet didn't make use of
this anyway (and pre-23.05 versions of the chapters didn't use quote
elements either).
also updates the nixpkgs manual to clarify that option docs support all
extensions (although it doesn't support headings at all, so heading
anchors don't work by extension).
|
|
|
|
The thunderbird derivation is using `buildMozillaMach` these days,
shared with Firefox and Librefox, so it is probably the correct
, although more complicated, successor.
|
|
Move the manpage-to-URL mapping to `doc/manpage-urls.json` so that we can
reuse that file elsewhere, and generate the `link-manpages.lua` filter from
that file.
Also modify the Pandoc filter so that it doesn't wrap manpages that are
already inside a link.
Keeping a Lua filter is essential for speed: a Python filter would
increase the runtime `md-to-db.sh` from ~20s to ~30s (but Python is not
to blame; marshalling Pandoc types to and from JSON is a costly operation).
Parsing in Lua seems tedious, so I went with the Nix way.
|
|
Leftovers from the CommonMark conversion.
|
|
|
|
|
|
Co-authored-by: Mostly Void <dit7ya@users.noreply.github.com>
|
|
|
|
|
|
The nixpkgs manual contains references to both sri hash and explicit
sha256 attributes. This is at best confusing to new users. Since the
final destination is exclusive use of sri hashes, see nixos/rfcs#131,
might as well push new users in that direction gently.
Notable exceptions to sri hash support are builtins.fetchTarball,
cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and
fetchCrate. None, other than builtins.fetchTarball, are fundamentally
incompatible, but all currently accept explicit sha256 attributes as
input. Because adding backwards compatibility is out of scope for this
change, they have been left intact, but migration to sri format has been
made for any using old hash formats.
All hashes have been manually tested to be accurate, and updates were
only made for missing upstream artefacts or bugs.
|
|
Match admonition syntax in
https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
|
|
Discussed and proposed at https://discourse.nixos.org/t/rules-around-adding-to-someones-pr/22671/3
|
|
helsinki-systems/feat/document-no-breaking-commits
doc: Document that the staging branches may be restricted
|
|
https://github.com/NixOS/nixpkgs/pull/89885 ensures that fetches are
done securely (i.e. without `--insecure`) when the `hash` parameter is one of
the four special "fake" hashes. However the manual was not updated in that PR.
This commit updates the manual to account for the already-merged changes from
that PR.
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
|
|
|
|
doc/contributing: enforce full commit hashes on github
|
|
|
|
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
|
|
|
|
Use `nix-shell` instead, but also give an example of the correct
flakes version of the commands.
|
|
|
|
treewide: markdown option docs
|
|
|
|
|
|
|
|
… and link from the coding-conventions chapter to it.
Closes #48569.
|
|
|
|
|
|
`git rm` should always be preferred over "normal" `rm`.
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
|
|
There is some doubt as to exactly how to enumerate all the merges from
one branch to another reliably. In the meantime, let's be a little
more vague.
|
|
docs: Make coding conventions use pname/version
|
|
lib/modules: Finally remove deprecated types.optionSet
|
|
Allows restricting patches to a specific subdirectory, à la
`git diff --relative=subdir`.
This cannot be done (cleanly) currently because the `includes` logic
happens *after* `stripLen` is applied, so we can't match on `subdir/*`.
This change adds a `relative` argument that makes this possible by
filtering files before doing any processing, and setting `stripLen` and
`extraPrefix` accordingly.
|
|
types.optionSet has been deprecated for almost 10 years now
(0e333688cea468a28516bf6935648c03ed62a7bb)! A removal
was already attempted in 2019
(27982b408e465554b8831f492362bc87ed0ec02a), but it was promptly
reinstantiated since some third-party uses were discovered
(f531ce75e4178c6867cc1d0f7fec96b2d5c3f1cb).
It's finally time to remove it for good :)
|
|
|
|
The documentation for this diagram explains that the blue arrows are
automatic processes which happen every six hours. There is no
explanation about how the purple arrows happen or how often.
As a new contributor to nixpkgs, I incorrectly assumed that the purple
arrows were also automatic processes (they aren't), which left me sort
of confused about what the whole scheme was accomplishing.
Recently I went through the github history to see how often these
events happen, and realized that the purple arrows are (a) triggered
manually by a nixpkgs project member and (b) happen much, much, much
less frequently than every six hours.
Now everything makes a lot more sense. I suggest the wording change
in this commit, or something similar, to save future contributors the
same confusion that I experienced.
|
|
|
|
Source:
https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
|
|
The current doc is wildly out of touch with reality. A regex search shows
the following stats.
```
Style example Frequency Regex used
nix-2-5: 8 [a-zA-Z]-[0-9]+(-[0-9]+)+ =
nix-2_5: 17 [a-zA-Z]-[0-9]+(_[0-9]+)+ =
nix_2_5: 689 [a-zA-Z]_[0-9]+(_[0-9]+)+ =
nix_2-5: 1 [a-zA-Z]_[0-9]+(-[0-9]+)+ =
```
|
|
The file was renamed/modified in 3f40ca4 but the documentation was not
updated. Closes #155049.
|
|
doc: remove reference to unix-man-urls.lua
|
|
docs: improve section `Stable release branches`
|
|
|
|
- Explain branch naming scheme for stable release branches
- Split into subsections `Automatically backporting ...` and
`Manually backporting...`.
|
|
|
|
Make it clear that we prefer using `pname` and `version` separated and
not the `name` attribute.
|
|
|
|
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
|
|
doc: Add support for manpage references
|
