Commit Graph

1654 Commits (master)

Author SHA1 Message Date
Ryan Mulligan c682532fce doc/functions/prefer-remote-fetch: convert to CommonMark 2021-06-07 20:18:39 -07:00
Ryan Mulligan e560790890
Merge pull request #125957 from ryantm/md-debug
doc/functions/debug: convert to CommonMark
2021-06-07 19:57:22 -07:00
Ryan Mulligan fbfdc8fc0b doc/functions/debug: convert to CommonMark 2021-06-07 19:56:38 -07:00
Ryan Mulligan 2f92034d30
Merge pull request #125838 from jtojnar/strict-commonmark
doc: Parse as CommonMark
2021-06-07 06:02:29 -07:00
Jan Tojnar 3c78ad2561
doc: Use markdown syntax for xrefs
Syntax is taken from MyST:

https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07 06:34:59 +02:00
Jan Tojnar adecb00f5a
doc: Build as CommonMark
We were using Pandoc’s Markdown parser. This is non-standard and might cause issues when we finally switch to some other tool.

Since RFC 0072 agreed on CommonMark, let’s switch to that.

We will use some extensions to make the limited syntax bearable but these are official so they should be more portable.
2021-06-07 06:34:59 +02:00
Jan Tojnar 6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Jan Tojnar ce6b1a4f8f
doc: Document markup syntax
Not depicted:

- Diagrams using Lua filter and dot
- fenced code attributes (enabled by the attributes extension)
2021-06-06 20:05:00 +02:00
Ryan Mulligan c43e0f4873
Merge pull request #125702 from alarsyo/db-to-md-nix-gitignore
doc: nix-gitignore to CommonMark
2021-06-06 07:35:06 -07:00
Antoine Martin 26ac257e4f doc: nix-gitignore to CommonMark
Closes #125670
2021-06-05 18:20:26 +02:00
Sandro c3f5d24b8d
Merge pull request #125494 from siraben/remove-stdenv-lib 2021-06-05 16:16:28 +02:00
Jan Tojnar 7497b4721c doc: Fix make in nix-shell
When running make manually, makeFlags will not be passed. Let’s just use an environment variable.
2021-06-05 13:25:48 +02:00
Silvan Mosberger 155ae682a5 buildGoModule/buildGoPackage: Introduce ldflags argument
Previously it was not possible to define multiple ldflags, since only
the last definition applies, and there's some quoting issues with
`buildFlagsArray`. With the new `ldflags` argument it's possible to do
this, e.g.

    ldflags = drv.ldflags or [] ++ [
      "-X main.Version=1.0"
    ]

can now properly append a flag without clearing all previous ldflags.
2021-06-05 09:54:36 +10:00
Ben Siraphob 68b5b850d5 coding-conventions: remove reference to stdenv.lib 2021-06-03 19:54:53 +07:00
Sandro Jäckel 89d5f4b3d0
treewide: setuptools_scm -> setuptools-scm 2021-06-03 12:44:33 +02:00
Daniël de Kok 9cca8ce446 doc: fix incorrect use of cargoDeps
Thanks to @bjornfor for reporting this error!
2021-06-01 13:14:28 +02:00
Maximilian Bosch 9ffd1e0413
Merge pull request #124739 from SFrijters/doc-fetchpatch
doc/coding-conventions: Add documentation for fetchpatch optional arguments
2021-05-28 22:13:11 +02:00
Stefan Frijters 585f63b364
doc/coding-conventions: Add documentation for fetchpatch optional arguments 2021-05-28 14:22:46 +02:00
Daniël de Kok 1da0b1dbc9
Merge pull request #122158 from danieldk/import-cargo-lock
rustPlatform.buildRustPackage: support direct use of Cargo.lock
2021-05-28 12:07:25 +02:00
Daniël de Kok b3969f3ad7 rustPlatform.buildRustPackage: support direct use of Cargo.lock
This change introduces the cargoLock argument to buildRustPackage,
which can be used in place of cargo{Sha256,Hash} or cargoVendorDir. It
uses the importCargoLock function to build the vendor
directory. Differences compared to cargo{Sha256,Hash}:

- Requires a Cargo.lock file.
- Does not require a Cargo hash.
- Retrieves all dependencies as fixed-output derivations.

This makes buildRustPackage much easier to use as part of a Rust
project, since it does not require updating cargo{Sha256,Hash} for
every change to the lock file.
2021-05-28 08:01:28 +02:00
Daniël de Kok 2f46d77e28 rustPlatform.importCargoLock: init
This function can be used to create an output path that is a cargo
vendor directory. In contrast to e.g. fetchCargoTarball all the
dependent crates are fetched using fixed-output derivations. The
hashes for the fixed-output derivations are gathered from the
Cargo.lock file.

Usage is very simple, e.g.:

importCargoLock {
  lockFile = ./Cargo.lock;
}

would use the lockfile from the current directory.

The implementation of this function is based on Eelco Dolstra's
import-cargo:

https://github.com/edolstra/import-cargo/blob/master/flake.nix

Compared to upstream:

- We use fetchgit in place of builtins.fetchGit.
- Sync to current cargo vendoring.
2021-05-28 08:01:25 +02:00
Ryan Mulligan c8e32eddf8
Merge pull request #120319 from fricklerhandwerk/docs-to-markdown
doc/using: convert to markdown
2021-05-27 06:44:16 -07:00
Domen Kožar d71078f4f4
Merge pull request #124273 from NixOS/backporting-action
Add backporting action
2021-05-25 11:38:29 +02:00
Domen Kožar 51c7afa95e
backport action: document the workflow 2021-05-25 09:47:33 +02:00
Thomas Depierre f55c3e2f21 beam-packages: drop erlang R18 R19 R20 and cuter 2021-05-25 07:38:41 +09:00
happysalada 6d1621c324 beam: fix documentation 2021-05-25 07:36:38 +09:00
happysalada a6cfe32089 elixir: add deprecation schedule docs 2021-05-24 10:14:17 +09:00
Alyssa Ross dc3dea22be doc/submitting-changes: should -> must
To me, as a native English speaker, this doesn't change the meaning of
the sentence at all.  But to a non-native speaker, this can read like
the staging-next rules are only recommendations.  Let's make this
clearer.
2021-05-23 20:26:32 +00:00
Robert Hensing ea0c94f50d
Merge pull request #123111 from hercules-ci/writeDirectReferencesToFile
writeDirectReferencesToFile and maintenance
2021-05-17 15:44:10 +02:00
Jan Tojnar b5f84d830b doc: Add anchors to dhall sections
This will ensure the sections have stable links as well as prevent conflicts (pandoc uses heading text for ids and DocBook requires unique ids across the book).
2021-05-17 09:37:49 +02:00
Sandro f66a5695b4
Merge pull request #121252 from NixOS/SuperSandro2000-patch-1
doc/contributing: add unnecessary string conversions
2021-05-17 02:40:29 +02:00
ydlr a2f3a63953
restore buildMix and its bootstrapper (#122374)
* restore mixBuild

remove bootstrapper by going through ERL_LIBS
mix will use ERL_LIBS to find compiled dependencies

Co-authored-by: Zach <zach@hipcreativeinc.com>
2021-05-17 08:05:40 +09:00
Gabriel Gonzalez b23797e2c5
dhall: Document language support in the Nixpkgs manual (#123051) 2021-05-15 08:51:08 -07:00
Robert Hensing ed4523186e writeReferencesToFile: docs and tests 2021-05-15 17:04:25 +02:00
Robert Hensing cc60f81e69 writeDirectReferencesToFile: init 2021-05-15 17:04:25 +02:00
Jonas Chevalier c6b62f2381
mkShell: introduce packages argument (#122180)
The distinction between the inputs doesn't really make sense in the
mkShell context.  Technically speaking, we should be using the
nativeBuildInputs most of the time.

So in order to make this function more beginner-friendly, add "packages"
as an attribute, that maps to nativeBuildInputs.

This commit also updates all the uses in nixpkgs.
2021-05-13 19:17:29 +02:00
David aaa16732ce rebar3: add rebar3WithPlugins 2021-05-11 08:59:57 +09:00
Erlend Pedersen 3452a739d1
nixpkgs-manual: lib.attrsets.mapAttrsToList returns a list (#122179) 2021-05-08 13:55:11 +02:00
Jan Tojnar 468cb5980b gnome: rename from gnome3
Since GNOME version is now 40, it no longer makes sense to use the old attribute name.
2021-05-08 09:47:42 +02:00
Jan Tojnar 48a0757b75
wrapGAppsHook4: init 2021-05-05 22:42:13 +02:00
Luke Granger-Brown 147c701583
Merge pull request #120534 from davidak/package-tests
doc: add instructions for creating package tests
2021-05-01 22:31:02 +01:00
Sandro 08ab1d9572
doc/contributing: add unnecessary string conversions 2021-04-30 11:31:48 +02:00
Sandro 226b043cef
doc/contributing: clarify stdenv.lib deprecation 2021-04-30 11:05:39 +02:00
Domen Kožar ba6f0e8f03
Merge pull request #110491 from neosimsim/agda-doc-fix-install-command
agda: fix code snippet for installing Agda
2021-04-27 17:40:36 +02:00
Patrick Hilhorst 04f82b9ebd doc/submitting-changes: remove incorrect remark
Tests don't only apply to NixOS modules, see for example tests/vscodium
2021-04-26 11:47:42 -04:00
John Ericson 14b427a7e4
Merge pull request #119092 from numinit/update-androidenv
androidenv: Allow multiple ndkVersions to be specified
2021-04-25 10:08:05 -04:00
fricklerhandwerk c30fe24120 docs/using: shellSession -> ShellSession
Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2021-04-25 10:31:02 +02:00
Jan Tojnar 0f1c4558d3
Merge branch 'master' into staging-next
Choose binwalk 2.3.1, 27 is legacy version for Python 2.
2021-04-25 02:50:48 +02:00
Morgan Jones a7e5b070be androidenv: Allow multiple ndkVersions to be specified
Android is deprecating ndk.dir in favor of specifying exact NDK
version in Gradle configuration. Ensure that we can support multiple
NDKs, and link them into the location the Android Gradle Plugin expects.
2021-04-24 15:56:08 -06:00
davidak c357fbeb51 doc: add instructions for creating package tests 2021-04-24 18:39:45 +02:00