3
0
Fork 0
forked from mirrors/nixpkgs
Commit graph

107 commits

Author SHA1 Message Date
Naïm Favier bff4bb5540
Merge pull request #208762 from ncfavier/link-manpages-options-doc 2023-01-09 11:57:01 +01:00
Martin Weinelt 8b79bf0432
doc/contributing/quick-start: Replace dead thunderbird link
The thunderbird derivation is using `buildMozillaMach` these days,
shared with Firefox and Librefox, so it is probably the correct
, although more complicated, successor.
2023-01-03 14:18:41 +01:00
Naïm Favier a8d4cf149c
doc: separate manpage URLs from the Pandoc filter
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.
2023-01-02 14:11:22 +01:00
Naïm Favier 3f6fed2e59
doc,nixos/doc: unescape ellipses
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +01:00
Anderson Torres 593381845f doc/contributing/coding-conventions: add subsection for language servers 2022-12-25 10:57:29 -03:00
figsoda 403e25e3e3 doc: fix typos 2022-12-17 18:21:48 -05:00
Valentin Gagarin d9f9ead58a
Update doc/contributing/coding-conventions.chapter.md
Co-authored-by: Mostly Void <dit7ya@users.noreply.github.com>
2022-12-10 11:46:53 +01:00
Valentin Gagarin db1a83aaa4 docs: fixup wording and formatting on JavaScript 2022-12-07 16:47:31 +01:00
Valentin Gagarin 53b5a47c12 document Import From Derivation (IFD) policy 2022-12-07 16:47:30 +01:00
Colin Arnott bac379f30a
doc: use sri hash syntax
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.
2022-12-04 06:12:18 +00:00
Ryan Mulligan f3d0e1d5c3 nixpkgs/doc: fix admonition syntax
Match admonition syntax in

https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
2022-11-08 07:30:20 -08:00
Stanisław Pitucha 713369c44b doc/contributing: Explicitly allow trivial changes by non-authors
Discussed and proposed at https://discourse.nixos.org/t/rules-around-adding-to-someones-pr/22671/3
2022-10-23 15:23:02 +11:00
Janne Heß 1b768f41e9
Merge pull request #173506 from helsinki-systems/feat/document-no-breaking-commits
doc: Document that the staging branches may be restricted
2022-10-21 22:58:33 +02:00
Adam Joseph 0d0c03fb0b
coding-conventions.chapter.md: update to account for #89885 (#191378)
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>
2022-10-12 11:08:50 +02:00
Sandro 1bb33d6dbe
doc/contributing: fix whitespace 2022-09-07 01:01:48 +02:00
Anderson Torres 6be0f0e057
Merge pull request #189241 from SuperSandro2000/git-full-hash
doc/contributing: enforce full commit hashes on github
2022-09-05 21:26:05 -03:00
Sandro Jäckel be09c1638d
doc/contributing: enforce full commit hashes on github 2022-09-04 00:50:35 +02:00
pennae 9c3c13b50d nixos/make-options-doc: add inline roles for varname/envar
both of these render distinctly from plain literals in the manpage, and
manpages even semantically distinguish between the two.
2022-08-31 16:21:10 +02:00
Matthias Bartelmeß 0ff5e21ea2
Correct instructions to obtain a hash for git repos 2022-08-04 00:31:31 +02:00
Johannes Maier f0100c6fa7 doc/contributing: replace outdated 'nix run' commands
Use `nix-shell` instead, but also give an example of the correct
flakes version of the commands.
2022-07-03 21:30:01 +02:00
AndersonTorres ba92e37183 doc/contributing/coding-conventions: add a section about file managers 2022-06-26 23:58:09 -03:00
Robert Hensing e2c261f2c0
Merge pull request #176146 from pennae/module-docs-markdown
treewide: markdown option docs
2022-06-21 13:16:02 +02:00
Graham Christensen 9284df58c1 maintainers: document new maintainers and team changes 2022-06-20 22:20:26 +02:00
Vladimír Čunát 7a99205619
Merge #162960: staging docs: explain that purple arrows are manual 2022-06-14 19:31:34 +02:00
pennae 320aa2a791 treewide: attempt at markdown option docs 2022-06-12 12:44:38 +02:00
Florian Klink 1cefcfab2d nixos/doc: move fetchpatch documentation to fetcher documentation
… and link from the coding-conventions chapter to it.

Closes #48569.
2022-06-03 14:37:31 +02:00
Janne Heß dabac4bf0c
doc: Document that the staging branches may be restricted 2022-05-18 17:37:48 +02:00
Arnout Engelen 1c73a0773c
doc: clarify what a 'mass rebuild' is 2022-05-09 12:31:21 +02:00
Matthias Beyer bdcb818804 Replace "rm" call with "git rm"
`git rm` should always be preferred over "normal" `rm`.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2022-05-03 13:38:50 +02:00
Adam Joseph 50217b01dd submitting-changes.chapter.md: avoid being specific
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.
2022-04-20 03:22:17 -07:00
Doron Behar 94eb0d16a3
Merge pull request #149667 from doronbehar/doc/pname-version-conventions
docs: Make coding conventions use pname/version
2022-04-14 12:00:59 +03:00
Silvan Mosberger 99d9d45630
Merge pull request #164651 from Infinisil/remove-optionSet
lib/modules: Finally remove deprecated types.optionSet
2022-03-25 17:41:57 +01:00
Naïm Favier bf7d13dc4f
fetchpatch: add relative
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.
2022-03-25 01:00:36 +01:00
Silvan Mosberger 96698efe0c lib/modules: Finally remove deprecated types.optionSet
types.optionSet has been deprecated for almost 10 years now
(0e333688ce)! A removal
was already attempted in 2019
(27982b408e), but it was promptly
reinstantiated since some third-party uses were discovered
(f531ce75e4).

It's finally time to remove it for good :)
2022-03-18 04:51:27 +01:00
Robert Hensing 3e39e243db doc/reviewing-contributions: Recommend mkRenamedOptionModuleWith 2022-03-09 14:53:53 +01:00
Adam Joseph 94c0e08808 submitting-changes.chapter.md: explain that purple arrows are manual
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.
2022-03-05 18:50:28 -08:00
AndersonTorres 3f19fc37a3 Move misc/vim-plugins to applications/editors/vim/plugins 2022-02-24 20:26:07 -03:00
Guillaume Girol 02a8d5984c doc: discourage setting phases, document/encourage runHook instead.
Source:
https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$mff3KCoPY5sfgsUhKn0e4va7hnz7KMXARaO2_UaLNM4?via=nixos.org&via=matrix.org&via=nixos.dev
2022-02-12 12:00:00 +00:00
Robert Hensing daca830722 doc/coding-conventions: Fix version attribute suffix to match reality
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]+)+ =
```
2022-01-26 14:40:20 +01:00
Nicolas Benes 5c8d6d6cee doc: fix broken link
The file was renamed/modified in 3f40ca4 but the documentation was not
updated. Closes #155049.
2022-01-15 16:07:55 +01:00
Renaud 3d6fc382d6
Merge pull request #152451 from ncfavier/unix-man-urls
doc: remove reference to unix-man-urls.lua
2022-01-03 16:05:37 +01:00
Jan Tojnar f24037746d
Merge pull request #149867 from erikarvstedt/docs-stable-release
docs: improve section `Stable release branches`
2021-12-30 16:29:39 +01:00
Naïm Favier 8583c5f48b
doc: remove reference to unix-man-urls.lua 2021-12-28 13:26:35 +01:00
Erik Arvstedt af46a4d635
docs: improve section Stable release branches
- Explain branch naming scheme for stable release branches
- Split into subsections `Automatically backporting ...` and
  `Manually backporting...`.
2021-12-28 12:09:28 +01:00
Guillaume Girol a15fbab8e9 doc: minimize mentions of nix-env -i without -A in nixpkgs manual 2021-12-18 12:00:00 +00:00
Doron Behar 01ec4349f2 docs: Make coding conventions use pname/version
Make it clear that we prefer using `pname` and `version` separated and
not the `name` attribute.
2021-12-08 18:40:01 +02:00
Sandro Jäckel dded550fcd
doc: fix typo 2021-10-28 10:48:34 +02:00
Sandro f289d93a41
doc/contributing: add lib.optional (#121251)
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2021-10-05 23:13:26 +02:00
Jan Tojnar 1e75936926
Merge pull request #130047 from NixOS/doc-manpage-role
doc: Add support for manpage references
2021-09-07 21:29:26 +02:00
Arnout Engelen d09e0be1c4
nixpkgs-docs: when to prefer passthru.tests over installCheckPhase
And mention you can have either lightweight 'package' or
more heavyweight 'NixOS' (module) tests.

This was suggested at
https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971
and discussed further at
https://github.com/NixOS/nixpkgs/pull/119731
2021-08-14 09:47:21 +02:00