about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2024-03-22doc: improve javascript conventions (#298127)Eli Flanagan1-13/+32
I created newlines per the <https://github.com/NixOS/nixpkgs/blob/master/doc/README.md#documentation-conventions> guide. This paves the way for future contributions to not be distracted by expected conventions.
2024-03-21Merge pull request #297687 from DanielSidhion/fix-manual-headingsSilvan Mosberger1-1/+1
doc: fix code to generate links for headings in the manual
2024-03-21doc: fix code to generate links for headings in the manualDS1-1/+1
2024-03-21Merge pull request #297347 from tzx/docs-right-location-buildPytonPackageMartin Weinelt1-2/+3
doc: document name binding for buildPythonPackage
2024-03-21doc: document name binding for buildPythonPackageTimmy Xiao1-2/+3
2024-03-20doc: Add troubleshooting for Cythonized code and pytest (#293069)Sarah Clark1-0/+4
Cython is a Python compiler that emits native .so modules. By default, python derivations run tests in the wrong directory to see these modules and tests fail. Issue #255262 documents the root cause and solution for this problem. This PR adds a description of the problem and the most common solution to the test troubleshooting list.
2024-03-19Merge pull request #281576 from yannham/refactor/cuda-setup-hooks-refactorSomeone1-1/+1
cudaPackages: generalize and refactor setup hooks
2024-03-19Merge pull request #178717 from ShamrockLee/write-multiple-referencesSomeone1-3/+7
trivial-builders: replace writeReferencesToFile with writeClosure
2024-03-19Merge pull request #296549 from TomaSajt/strip-java-archives-hookPol Dellaiera1-3/+26
add stripJavaArchivesHook and use treewide
2024-03-18Merge pull request #294019 from Lurkki14/doc-makedesktopitemDaniel Sidhion1-0/+101
doc: document makeDesktopItem
2024-03-19writeClosure: init, replacing writeReferencesToFileYueh-Shun Li1-3/+7
Replace writeReferencesToFile with writeClosure. Make writeClosure accept a list of paths instead of a path. Re-implement with JSON-based exportReferencesGraph interface provided by __structuredAttrs = true. Reword the documentation. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com> Co-authored-by: Someone Serge <sergei.kozlukov@aalto.fi>
2024-03-18doc: document makeDesktopItemJussi Kuokkanen1-0/+101
2024-03-18doc/mkYarnPackage: document better distPhase and doDistDoron Behar1-2/+2
2024-03-17doc: include stripJavaArchivesHook in the java sectionTomaSajt1-3/+26
2024-03-16Merge branch 'master' into haskell-updatesmaralorn5-223/+339
2024-03-16doc: fix and simplify stylesheets for the manuals, fix nrd bug (#295847)Daniel Sidhion5-223/+339
* doc: fix and simplify stylesheets for the manuals, fix nrd bug * Add anchorjs script to add links on section headers * Fix another nrd bug, address style changes * Use span instead of a for inline span syntax
2024-03-15cudaPackages: generalize and refactor setup hookYann Hamdaoui1-1/+1
This PR refactor CUDA setup hooks, and in particular autoAddOpenGLRunpath and autoAddCudaCompatRunpathHook, that were using a lot of code in common (in fact, I introduced the latter by copy pasting most of the bash script of the former). This is not satisfying for maintenance, as a recent patch showed, because we need to duplicate changes to both hooks. This commit abstract the common part in a single shell script that applies a generic patch action to every elf file in the output. For autoAddOpenGLRunpath the action is just addOpenGLRunpath (now addDriverRunpath), and is few line function for autoAddCudaCompatRunpathHook. Doing so, we also takes the occasion to use the newer addDriverRunpath instead of the previous addOpenGLRunpath, and rename the CUDA hook to reflect that as well. Co-Authored-By: Connor Baker <connor.baker@tweag.io>
2024-03-15Merge master into haskell-updatesgithub-actions[bot]2-72/+0
2024-03-14Merge pull request #293416 from DanielSidhion/remove-makesnapSilvan Mosberger2-72/+0
snapTools: remove
2024-03-13Merge master into haskell-updatesgithub-actions[bot]2-1/+13
2024-03-11trivial-builders: Deduplicate docsRobert Hensing2-1/+13
I didn't have the opportunity to do all work at once, so I've added TODOs to bring attention to the situation.
2024-03-09Merge master into haskell-updatesgithub-actions[bot]1-0/+31
2024-03-08Merge pull request #289231 from adisbladis/fetchnpmlockadisbladis1-0/+31
importNpmLock: init
2024-03-07Merge master into haskell-updatesgithub-actions[bot]13-74/+69
2024-03-06doc/lua.section.md: update lua documentationMatthieu Coudron1-18/+8
2024-03-06Remove top level `with lib;` in docs (#293829)Philip Taron2-2/+9
2024-03-06Nix docs: remove `with lib;` from example codeAnderson Torres11-52/+52
Following [Best Practices](https://nix.dev/guides/best-practices#with-scopes), `with` is a problematic language construction and should be avoided. Usually it is employed like a "factorization": `[ X.A X.B X.C X.D ]` is written `with X; [ A B C D ]`. However, as shown in the link above, the syntatical rules of `with` are not so intuitive, and this "distributive rule" is very selective, in the sense that `with X; [ A B C D ]` is not equivalent to `[ X.A X.B X.C X.D ]`. However, this factorization is still useful to "squeeze" some code, especially in lists like `meta.maintainers`. On the other hand, it becomes less justifiable in bigger scopes. This is especially true in cases like `with lib;` in the top of expression and in sets like `meta = with lib; { . . . }`. That being said, this patch removes most of example code in the current documentation. The exceptions are, for now - doc/functions/generators.section.md - doc/languages-frameworks/coq.section.md because, well, they are way more complicated, and I couldn't parse them mentally - yet another reason why `with` should be avoided!
2024-03-05python38: removeMartin Weinelt1-2/+0
The end of life for Python 3.8 is scheduled for 2024/10. As such it cannot be a part of NixOS 24.05, because its support cycle goes past that.
2024-03-04snapTools: removeDS2-72/+0
`snapTools.makeSnap` has produced broken snaps since at least Oct 2020, as indicated by the following issue: https://github.com/NixOS/nixpkgs/issues/100618 No person has shown interest in maintaining it, and given that there is no fix available, it's assumed that all attempts made to fix that function have not succeeded. Given that `snapTools` only contained `makeSnap`, it was removed completely.
2024-03-05Merge master into haskell-updatesgithub-actions[bot]2-4/+6
2024-03-04doc: small fix for nightly in derivation snippet (#292688)Leon1-2/+2
2024-03-05importNpmLock: initadisbladis1-0/+31
This is an alternative to `fetchNpmDeps` that is notably different in that it uses metadata from `package.json` & `package-lock.json` instead of specifying a fixed-output hash. Notable features: - IFD free. - Only fetches a node dependency once. No massive FODs. - Support for URL, Git and path dependencies. - Uses most of the existing `npmHooks` `importNpmLock` can be used _only_ in the cases where we need to check in a `package-lock.json` in the tree. Currently this means that we have 13 packages that would be candidates to use this function, though I expect most usage to be in private repositories. This is upstreaming the builder portion of https://github.com/adisbladis/buildNodeModules into nixpkgs (different naming but the code is the same). I will archive this repository and consider nixpkgs the new upstream once it's been merged. For more explanations and rationale see https://discourse.nixos.org/t/buildnodemodules-the-dumbest-node-to-nix-packaging-tool-yet/35733 Example usage: ``` nix stdenv.mkDerivation { pname = "my-nodejs-app"; version = "0.1.0"; src = ./.; nativeBuildInputs = [ importNpmLock.hooks.npmConfigHook nodejs nodejs.passthru.python # for node-gyp npmHooks.npmBuildHook npmHooks.npmInstallHook ]; npmDeps = buildNodeModules.fetchNodeModules { npmRoot = ./.; }; } ```
2024-03-04Merge pull request #293163 from Aleksanaa/doc/qtK9001-2/+4
doc/qt: minor fixes
2024-03-04doc/qt: minor fixesaleksana1-2/+4
2024-03-01Merge master into haskell-updatesgithub-actions[bot]3-77/+239
2024-02-29doc: update docs for portableService, follow doc conventionsDS2-57/+151
2024-02-29Merge pull request #290886 from DanielSidhion/update-ocitoolsSilvan Mosberger2-20/+88
doc: update docs in ociTools, follow doc conventions
2024-02-29doc: update docs in ociTools, follow doc conventionsDS2-20/+88
2024-02-29Merge master into haskell-updatesgithub-actions[bot]2-1/+21
2024-02-28Merge pull request #291715 from DanielSidhion/document-private-keyDaniel Sidhion1-0/+7
doc: document publicly-known private key for darwin.linux-builder
2024-02-28doc: fix darwin-builder doc (#291518)yihuang1-1/+4
2024-02-28Merge pull request #282886 from WxNzEMof/docker-tools-uidRobert Hensing1-0/+10
Allow streaming layered containers with non-root Nix store
2024-02-26doc: document publicly-known private key for darwin.linux-builderDS1-0/+7
2024-02-27Merge master into haskell-updatesgithub-actions[bot]1-1/+1
2024-02-26Document the new streamLayeredImage parametersWxNzEMof1-0/+10
2024-02-26doc: Fix typo resulting in broken link in manualMihai Maruseac1-1/+1
I was looking at https://nixos.org/manual/nixpkgs/stable/#buildpythonpackage-parameters to import a Python package and noticed that the link for the `hooks` in `pyproject` option is broken due to a typo (used <kbd>0</kbd> instead of <kbd>)</kbd>). Signed-off-by: Mihai Maruseac <mihai.maruseac@gmail.com>
2024-02-26haskellPackages: add dontCheckIf helperWolfgang Walther1-0/+5
Using this helper will prevent introducing problematic doCheck = condition overrides, which accidentally re-enable previously disabled tests.
2024-02-25Merge master into haskell-updatesgithub-actions[bot]2-1/+6
2024-02-23Merge branch 'master' into staging-nextWeijia Wang1-0/+4
2024-02-23Merge master into haskell-updatesgithub-actions[bot]1-0/+4