Commit Graph

258 Commits

Author SHA1 Message Date
Kenichi Kamiya
2d4dfc04b4
doc/stdenv: fix a typo 2024-11-20 16:08:21 +09:00
Randy Eckenrode
b8b4cdc903
doc: revise Darwin SDK documentation
Based on experience with other maintainers trying to update their
packages, the documentation has been updated for clarity. It is also no
longer recommended to propagate an SDK in most circumstances.
2024-11-08 15:14:12 -05:00
Randy Eckenrode
deabb1ff4d
doc: update platform documentation for the new Darwin SDK pattern 2024-10-25 21:12:34 -04:00
Artturin
2db8942790
doc/stdenv/cross-compilation: Add 'Using -static outside a isStatic platform' (#344985) 2024-10-20 22:34:36 +03:00
Artturin
3f144b1aa0 doc/stdenv/cross-compilation: Add 'Using -static outside a isStatic platform'
This issue often comes up when builds use `-static` in their own build
system

This may not be the correct location for this as it's not strictly a
cross issue, but it's the best one I can think of

Inspired by someone wanting to build a `riscv-busybox-initramfs` and just
adding `pkgsCross.riscv32.stdenv.cc` to `nativeBuildInputs`
2024-10-20 01:00:06 +03:00
Harry Askham
065da7698d doc: Cross-link mention of symlinkJoin in 'Multiple-output packages'
Per #36886, would have saved me some time today to have the trivial
builder more visible.
2024-10-18 20:02:03 +02:00
github-actions[bot]
ca2d394166
Merge master into staging-next 2024-10-11 12:05:38 +00:00
Lin Jian
7e72cc4e38
doc: fix typo 2024-10-11 09:22:13 +08:00
K900
0717a4da77 Merge remote-tracking branch 'origin/master' into staging-next 2024-10-09 21:08:25 +03:00
Artturin
40799fc06d treewide: replace stdenv.is in non nix files
Continuing e0464e4788
2024-09-27 19:07:45 +03:00
github-actions[bot]
1c4acc409e
Merge staging-next into staging 2024-09-16 06:05:33 +00:00
Tomodachi94
066125b663
doc/stdenv/stdenv: document runHook function
Not quite satisfied with this, but it's better than nothing.
2024-09-14 21:28:09 -07:00
Philip Taron
4160ccc634
treewide: handle *Phases variables __structuredAttrs-agnostically (#339117) 2024-09-07 09:17:57 -07:00
seth
8bc8bbd1c9
doc/stdenv: fix typo in sourceRoot section 2024-09-04 14:43:23 -04:00
Yueh-Shun Li
5ec4f676b4 doc/stdenv: document the format of *Phases
Require the elements of *Phases not to contain spaces.

Require the *Phases attribute to be specified as Nix Language lists.
2024-09-03 05:56:17 +08:00
Robert Scott
745046d266 doc/stdenv: hardening flags: add section on pacret hardening flag 2024-07-28 19:27:21 +01:00
Emily
8a837af302
Merge pull request #326819 from risicle/ris-shadowstack
cc-wrapper: add support for `shadowstack` hardening flag
2024-07-28 19:07:52 +01:00
Robert Scott
5ce990eb57 doc/stdenv: add section on shadowstack hardening flag 2024-07-28 17:40:53 +01:00
Aleksana
40c6a068bd
Merge pull request #324687 from kini/add-sourceProvenance-subheading
doc/meta: Add sourceProvenance to "Standard meta-attributes" section
2024-07-26 11:07:05 +08:00
Alexis Hildebrandt
ab42ca141a doc: Remove indefinite article and ending period from example meta.description
so that meta.description examples shown in the documentation
align with recommendations given in the "Meta attributes" section
in pkgs/README.md.

The changes were made with the following commands:
nix run nixpkgs#silver-searcher -- -l0 'description\s*=\s*"([Aa]n?|[Tt]he)\s' doc \
  | xargs -0 nix run nixpkgs#gnused -- -i '' -Ee '/description/s/"([Aa]n?|[Tt]he)\s(.)/"\U\2/'
nix run nixpkgs#silver-searcher -- -l0 'description\s*=\s*".*\."' doc \
  | xargs -0 nix run nixpkgs#gnused -- -i '' -Ee '/description/s/\."/"/'
2024-07-20 09:18:42 +02:00
John Ericson
000b58721f Merge remote-tracking branch 'upstream/master' into openbsd-static 2024-07-09 18:18:47 -04:00
John Ericson
676df1cf2d openbsd: Add static linking support
I've had better luck creating statically-linked binaries that work than
dynamically-linked ones, so this is needed quite practically.
2024-07-09 18:17:06 -04:00
Keshav Kini
89fcddbc8c doc/meta: Add sourceProvenance to "Standard meta-attributes" section
`meta.sourceProvenance` has its own level 2 heading at the bottom of the file,
but unlike the other meta-attributes it doesn't have a level 3 heading under the
"Standard meta-attributes" section.  Readers looking at the list of subheadings
directly under the "Standard meta-attributes" section header may not realize
that `meta.sourceProvenance` exists unless they scroll down to the bottom of the
page.

This commit adds a level 3 heading for sourceProvenance under "Standard
meta-attributes".
2024-07-04 14:58:25 -07:00
github-actions[bot]
aba75819b6
Merge master into staging-next 2024-07-03 18:01:04 +00:00
aleksana
19bbe0b3eb doc/meta: make meta.description consistent with contributing document 2024-07-04 01:22:08 +08:00
github-actions[bot]
d77a3adc09
Merge master into staging-next 2024-07-03 00:02:45 +00:00
Doron Behar
f42d4debf0 doc: recommend versionCheckHook whenever relevant 2024-06-28 18:03:59 +03:00
Robert Scott
f52a4c6810 doc/stdenv: hardening flags: add example error for trivialautovarinit 2024-06-22 01:11:27 +01:00
Rick van Schijndel
43ce0f9ee0
Merge pull request #318256 from risicle/ris-stack-clash-protection
cc-wrapper: add stack clash protection hardening flag
2024-06-19 19:54:30 +02:00
github-actions[bot]
f9c7b930b4
Merge staging-next into staging 2024-06-11 12:01:44 +00:00
Travis A. Everett
9ff9bbdb34
doc: add stdenv passthru chapter (#315909)
* doc: add stdenv passthru chapter

Broad strokes:
- create the chapter
- move existing stdenv passthru coverage into it
- move out-of-place coverage of passthru.tests from the stdenv meta chapter into it
- (try to) apply 1-sentence-per-line to text I've touched
- add legacy anchors for everything moved
- update existing links to the new anchors
- add tentative motivating text
- make nixpkgs-internal links relative/branchless

razor: if it is only ever needed by contributors, which is likely if links
refer to the latest revision of the source code, then it's for
the contributor guide

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-06-11 10:51:03 +02:00
Robert Scott
a3f5640dd7 doc/stdenv: hardening flags: add section on stackclashprotection 2024-06-07 20:24:46 +01:00
Robert Scott
932bf58e90 doc/stdenv: hardening flags: move zerocallusedregs into "enabled by default" section
following dd80ca4d00
2024-06-07 20:17:51 +01:00
Arnout Engelen
eb83125aa3
Merge pull request #315616 from doronbehar/doc/installCheckPhase
doc/meta: Mention --version as a good usecase for installCheckPhase
2024-06-07 11:41:37 +02:00
Robert Scott
062f1fa52a doc/stdenv: hardening flags: add section on trivialautovarinit 2024-06-05 23:10:20 +01:00
Robert Scott
39f39b5568 doc/stdenv: hardening flags: add section on zerocallusedregs 2024-06-05 23:10:20 +01:00
Robert Scott
65cc6d3cf1 doc/stdenv: hardening flags: add section on fortify3 2024-06-05 23:10:19 +01:00
Robert Scott
a8062e526c doc/stdenv: hardening flags: add note on conditional support for some flags 2024-06-05 23:10:12 +01:00
Doron Behar
0aa9043370 doc/meta: still mention testVersion near the installCheckPhase recommendation 2024-05-30 16:33:27 +03:00
Doron Behar
444c2b6dd0 doc/meta: Mention --version as a good usecase for installCheckPhase 2024-05-30 16:09:04 +03:00
Doron Behar
f4e6f41b72 doc/meta: better explain an advantage or passthru.tests 2024-05-30 16:09:03 +03:00
Doron Behar
f4e7ce7719 doc/meta: small link target shortenning
Shorten the path from the link to the to actual content about
passthru.tests - the content was moved into pkgs/README.md .
2024-05-30 16:09:03 +03:00
Doron Behar
2093ef28d9 doc/meta: mention how Hydra and other tools don't run passthru.tests 2024-05-30 16:09:03 +03:00
Alyssa Ross
20ca4f5529 doc: fix meta.badPlatforms example
error: attribute 'isStatic' missing
2024-05-13 10:24:25 +02:00
Aleksana
fe0c92572f
doc/stdenv: document prefixKey more precisely (#302535)
* doc/stdenv: document prefixKey more precisely

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-04-08 14:07:40 +02:00
K900
59bccda153 Revert "stdenv: add meta.repository field"
This reverts commit 7e1443abbb.
2024-03-30 17:19:21 +03:00
a-n-n-a-l-e-e
2809c84cfb
Merge pull request #294347 from lolbinarycat/meta.repository
stdenv: add meta.repository field
2024-03-29 13:03:04 -07:00
binarycat
7e1443abbb stdenv: add meta.repository field 2024-03-29 14:34:09 -04:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Janne Heß
bc77c7a973 treewide: Mark Nix blocks in markdown as Nix
This should help us with highlighting and future formatting.
2024-03-28 09:28:12 +01:00