diff options
author | Frederik Rietdijk <fridh@fridh.nl> | 2020-01-10 10:34:04 +0100 |
---|---|---|
committer | Frederik Rietdijk <fridh@fridh.nl> | 2020-01-10 10:34:04 +0100 |
commit | 5ad16cb27fd81cb67db4da80283e147bea4e1c25 (patch) | |
tree | ad648118454028113d3b5236b27754151dc498b5 /doc | |
parent | eb1369670b5a4e616ff0cf4100616479b1fa3064 (diff) | |
parent | 773494d0ea6fdf3a40561b44b805b90ae1949292 (diff) | |
download | nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.tar nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.tar.gz nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.tar.bz2 nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.tar.lz nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.tar.xz nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.tar.zst nixpkgs-5ad16cb27fd81cb67db4da80283e147bea4e1c25.zip |
Merge master into staging-next
Diffstat (limited to 'doc')
-rw-r--r-- | doc/contributing/submitting-changes.xml | 63 | ||||
-rw-r--r-- | doc/languages-frameworks/haskell.section.md | 29 |
2 files changed, 30 insertions, 62 deletions
diff --git a/doc/contributing/submitting-changes.xml b/doc/contributing/submitting-changes.xml index f283ae1e685..73222c1a49a 100644 --- a/doc/contributing/submitting-changes.xml +++ b/doc/contributing/submitting-changes.xml @@ -13,7 +13,7 @@ </listitem> <listitem> <para> - Fork the repository on GitHub. + Fork <link xlink:href="https://github.com/nixos/nixpkgs/">the Nixpkgs repository</link> on GitHub. </para> </listitem> <listitem> @@ -22,15 +22,10 @@ <itemizedlist> <listitem> <para> - You can make branch from a commit of your local <command>nixos-version</command>. That will help you to avoid additional local compilations. Because you will receive packages from binary cache. - <itemizedlist> - <listitem> - <para> - For example: <command>nixos-version</command> returns <command>15.05.git.0998212 (Dingo)</command>. So you can do: - </para> - </listitem> - </itemizedlist> + You can make branch from a commit of your local <command>nixos-version</command>. That will help you to avoid additional local compilations. Because you will receive packages from binary cache. For example <screen> +<prompt>$ </prompt>nixos-version --hash +0998212 <prompt>$ </prompt>git checkout 0998212 <prompt>$ </prompt>git checkout -b 'fix/pkg-name-update' </screen> @@ -47,13 +42,11 @@ <listitem> <para> Make commits of logical units. - <itemizedlist> - <listitem> - <para> - If you removed pkgs, made some major NixOS changes etc., write about them in <command>nixos/doc/manual/release-notes/rl-unstable.xml</command>. - </para> - </listitem> - </itemizedlist> + </para> + </listitem> + <listitem> + <para> + If you removed pkgs or made some major NixOS changes, write about it in the release notes for the next stable release. For example <command>nixos/doc/manual/release-notes/rl-2003.xml</command>. </para> </listitem> <listitem> @@ -178,7 +171,7 @@ Additional information. </listitem> <listitem> <para> - Rebase you branch against current <command>master</command>. + <link xlink:href="https://git-scm.com/book/en/v2/Git-Branching-Rebasing">Rebase</link> your branch against current <command>master</command>. </para> </listitem> </itemizedlist> @@ -194,36 +187,12 @@ Additional information. </listitem> <listitem> <para> - Create pull request: - <itemizedlist> - <listitem> - <para> - Write the title in format <command>(pkg-name | nixos/<module>): improvement</command>. - <itemizedlist> - <listitem> - <para> - If you update the pkg, write versions <command>from -> to</command>. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - Write in comment if you have tested your patch. Do not rely much on <command>TravisCI</command>. - </para> - </listitem> - <listitem> - <para> - If you make an improvement, write about your motivation. - </para> - </listitem> - <listitem> - <para> - Notify maintainers of the package. For example add to the message: <command>cc @jagajaga @domenkozar</command>. - </para> - </listitem> - </itemizedlist> + Create the pull request + </para> + </listitem> + <listitem> + <para> + Follow <link xlink:href="https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md#submitting-changes">the contribution guidelines</link>. </para> </listitem> </itemizedlist> diff --git a/doc/languages-frameworks/haskell.section.md b/doc/languages-frameworks/haskell.section.md index be5c7b7c8d1..b485ec583ec 100644 --- a/doc/languages-frameworks/haskell.section.md +++ b/doc/languages-frameworks/haskell.section.md @@ -84,37 +84,36 @@ nix-env -qaP -A nixos.haskellPackages nix-env -iA nixos.haskellPackages.cabal-install ``` -Our current default compiler is GHC 7.10.x and the `haskellPackages` set -contains packages built with that particular version. Nixpkgs contains the -latest major release of every GHC since 6.10.4, however, and there is a whole -family of package sets available that defines Hackage packages built with each -of those compilers, too: +Our current default compiler is GHC 8.6.x and the `haskellPackages` set +contains packages built with that particular version. Nixpkgs contains the last +three major releases of GHC and there is a whole family of package sets +available that defines Hackage packages built with each of those compilers, +too: ```shell -nix-env -f "<nixpkgs>" -qaP -A haskell.packages.ghc6123 -nix-env -f "<nixpkgs>" -qaP -A haskell.packages.ghc763 +nix-env -f "<nixpkgs>" -qaP -A haskell.packages.ghc844 +nix-env -f "<nixpkgs>" -qaP -A haskell.packages.ghc882 ``` The name `haskellPackages` is really just a synonym for -`haskell.packages.ghc7102`, because we prefer that package set internally and +`haskell.packages.ghc865`, because we prefer that package set internally and recommend it to our users as their default choice, but ultimately you are free to compile your Haskell packages with any GHC version you please. The following command displays the complete list of available compilers: ``` $ nix-env -f "<nixpkgs>" -qaP -A haskell.compiler -haskell.compiler.ghc822 ghc-8.2.2 -haskell.compiler.integer-simple.ghc822 ghc-8.2.2 +haskell.compiler.ghc8101 ghc-8.10.0.20191210 +haskell.compiler.integer-simple.ghc8101 ghc-8.10.0.20191210 +haskell.compiler.ghcHEAD ghc-8.10.20191119 +haskell.compiler.integer-simple.ghcHEAD ghc-8.10.20191119 haskell.compiler.ghc822Binary ghc-8.2.2-binary haskell.compiler.ghc844 ghc-8.4.4 haskell.compiler.ghc863Binary ghc-8.6.3-binary -haskell.compiler.ghc864 ghc-8.6.4 -haskell.compiler.integer-simple.ghc864 ghc-8.6.4 haskell.compiler.ghc865 ghc-8.6.5 haskell.compiler.integer-simple.ghc865 ghc-8.6.5 haskell.compiler.ghc881 ghc-8.8.1 haskell.compiler.integer-simple.ghc881 ghc-8.8.1 -haskell.compiler.ghcHEAD ghc-8.9.20190601 -haskell.compiler.integer-simple.ghcHEAD ghc-8.9.20190601 -haskell.compiler.ghcjs84 ghcjs-8.4.0.1 +haskell.compiler.ghc882 ghc-8.8.1.20191211 +haskell.compiler.integer-simple.ghc882 ghc-8.8.1.20191211 haskell.compiler.ghcjs ghcjs-8.6.0.1 ``` |