Commit Graph

302 Commits

Author SHA1 Message Date
Vladimír Čunát
2bbae9696a nixpkgs manual introduction: improve
- make line wrapping more consistent (overlong lines)
- don't stress the manual is *only* for contributors,
  as it does contain some user-guide parts, including the intro itself
- since March our Hydra publishes binaries immediately,
  not waiting for channel update
2016-04-05 10:06:10 +02:00
Domen Kožar
ccdda96c2f manual: use a better relaxng validation tool #4966 2016-03-30 18:07:34 +01:00
Frederik Rietdijk
df79303703 Merge pull request #13700 from FRidh/python-docs
Documentation: rewrite Python
2016-03-30 08:35:23 +02:00
Vladimír Čunát
b44b0ab27c nixpkgs manual: remove cruft from a merge conflict
It was clearly added unintentionally during #14243 merge.
2016-03-29 10:02:57 +02:00
Rodney Lorrimar
123da5c1c1 nixpkgs manual: Add documentation for bower2nix
Fixes #9459
Fixes #13214
2016-03-28 08:25:45 +01:00
Vladimír Čunát
e3da83297f texlive: document in nixpkgs manual
Fixes #13240. It's not really better than source-code comments it replaced,
but it's in a better accessible place.
2016-03-27 14:29:18 +02:00
Vladimír Čunát
c86a8fc19f doc: remove comments that are no longer relevant 2016-03-27 14:29:18 +02:00
Vladimír Čunát
b405e82edb ruby docs: improve the example
- missing cd command
- invoke bundler through nix-shell, so it doesn't need to be on $PATH
  Note: running bundix through nix-shell won't work ATM, as the shell sets
  SSL_CERT_FILE=/no-cert-file.crt which prevents fetching throug https.
- use version from gemset to simplify updating
- don't break line in meta.description
2016-03-20 13:33:20 +01:00
Joachim Fasting
49dc7e2d61 manual: fix meta.description in ruby example expression
Noted by @namore on github
2016-03-18 17:27:15 +01:00
Frederik Rietdijk
0ed331cf09 Documentation: fix usage of useChapters 2016-03-12 15:44:02 -05:00
Frederik Rietdijk
4c1525c1f8 Documentation: rewrite Python
- Rewrite current documentation
- Add introduction/tutorial
- Convert to markdown
2016-03-12 15:44:02 -05:00
Frederik Rietdijk
9310bd15de Revert "Documentation: rewrite Python docs" 2016-03-05 18:01:23 -05:00
Frederik Rietdijk
6af076730e Documentation: rewrite Python
- Rewrite current documentation
- Add introduction/tutorial
- Convert to markdown
2016-03-05 17:57:38 -05:00
Mathieu Boespflug
7fedb7c992 Move buildStackProject to haskell.lib. 2016-03-04 21:24:42 +01:00
Mathieu Boespflug
6f09628c32 haskell: tell users to use Stack's nix support when missing system library. 2016-03-04 21:18:14 +01:00
Mathieu Boespflug
01f384b8b4 haskell: Add documentation for haskell.buildStackProject to user guide.
This section documents introduces Stack's primitive Nix support as well.
2016-03-04 21:18:14 +01:00
Franz Pletz
7f7ebe5bf6 nixpkgs manual: Fix license strings docs
The wrong usage of unfree-redistributable fixed in
ea242619fb can be explaind by unclear
documention, specifically the section in the nixpkgs manual describing
generic licenses it is written to use attributes from `stdenv.lib.licenses`
but in the list the strings form was documented without quotation marks.

This confuses people because the package builds fine locally but failes
the tests on travis-ci.
2016-02-24 01:48:02 +01:00
Michel Kuhlmann
312494180d nixpkgs manual: add basic R documentation, fixes #13362
also fixes #13243
2016-02-22 10:16:06 +01:00
Frederik Rietdijk
92179785b6 DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263)
What I missed when I began using Nix and NixOS was a clear overview of
how packages, channels, Hydra, the master branch and updates to channels
relate to each other.

I've noticed I am not the only one, given the amount of times these
questions pop up.

For now I propose to include this in the Nixpkgs manual, since this
seems to be the best fit. However, I think it would be good to include
this in either a new manual, i.e., a user manual, or an 'official'
tutorial.
2016-02-21 11:32:22 +01:00
Vladimír Čunát
b8c489e781 Merge branch 'staging'
It seemed very fine on Hydra before it was cancelled due to glibc rebuild,
in particular the nixpkgs unstable job succeeded except for
bootstrap-tarball tests which should be fine after ee994dfae6.

Therefore, let's avoid another mass rebuild by merging now when we don't
have binaries for master anyway.
2016-02-17 10:54:26 +01:00
Vladimír Čunát
4ca2332bac nixpkgs manual: fix typo in filename 2016-02-17 10:52:42 +01:00
Vladimír Čunát
e9520e81b3 Merge branch 'master' into staging 2016-02-17 10:06:31 +01:00
John Ericson
e756536392 doc: Fix URL to ghc-paths patch 2016-02-13 17:13:33 -08:00
Vladimír Čunát
de0af30716 Merge branch 'master' into staging 2016-01-29 10:19:48 +01:00
Arthur Noel
903129f770 dockerTools: private registry support
* authorization token is optional
* registry url is taken from X-Docker-Endpoints header
* pull.sh correctly resumes partial layer downloads
* detjson.py does not fail on missing keys
2016-01-27 21:13:07 +00:00
Vladimír Čunát
2af19df364 Merge branch 'master' into staging 2016-01-25 10:02:25 +01:00
Benjamin Staffin
420bb27a7b docs: Mention autoreconfHook in Package Setup Hooks 2016-01-23 18:19:23 -05:00
Nikolay Amiantov
dc162f648c Merge pull request #12284 from abbradar/bundlerenv-wrapper
bundlerEnv: add wrapper
2016-01-23 12:02:09 +03:00
Nikolay Amiantov
9c1d8037c0 nixpkgs manual: add a section about passthru 2016-01-21 19:47:53 +03:00
Nikolay Amiantov
f727f815cb nixpkgs manual: mention preferLocalBuild and enableParallelBuilding 2016-01-21 18:44:27 +03:00
Nikolay Amiantov
a98dfaa6b9 nix manual: add bundlerEnv.env and .wrapper items descriptions 2016-01-21 13:10:09 +03:00
Eric Merritt
8021b5241c rebar3: refactor to make hermetic
This adds changes to the rebar3 expression that patch rebar3 to force it
to be hermetic. Now, by default, rebar3 literally can't download
anything. A 'rebar3-open' expression was added for those folks whe want
the normal rebar3.
2016-01-18 08:19:15 -08:00
Eric Merritt
6a493a2b43 erlang support: Add minimal documentation to nix
This commit adds some very minimial documentation to the Nix
manual. Hopefully, its enough to get someone started and serve as a
first footstep for future documentation writers
2016-01-15 08:17:33 -08:00
Luca Bruno
4a4561ce24 dockerTools: nix functions for manipulating docker images 2016-01-13 10:27:37 +01:00
Kranium Gikos Mendoza
762d55211a docs: kernelPackagesFor -> linuxPackagesFor 2016-01-09 06:02:00 +08:00
Peter Simons
5d482336b9 doc/meta.xml: don't encourage users to add a meta.version attribute
That attribute is completely redundant since it just duplicates information
from "name".

Cc: @7c6f434c who added that section in e39b1f4ec8.
2016-01-05 12:36:33 +01:00
Vladimír Čunát
3e4035695c nixpkgs manual: add idris docs generated from *.md
I also modified the nesting approach in haskell docs
to allow more uniform handling of markdown -> docbook conversions.
/cc #11308.
2015-12-21 13:01:59 +01:00
Vladimír Čunát
ef21e5ee60 nixpkgs manual: split languages into separate files
There's no change in content except for amending the title of the
section to mention "frameworks", as e.g. I don't consider Qt a language,
and it's likely there will be more of similar cases in future.

To be certain, I checked diff of the generated HTMLs.
2015-12-19 16:08:00 +01:00
aszlig
4ba31045e4 nixpkgs manual: more strict commit policy (close #11609) 2015-12-18 15:00:33 +01:00
Avery Glitch
b72bcd1e32 Fixed a syntax error in the buildFHSChrootEnv example. Also, fixed the manual.xml so it actually builds. 2015-12-18 00:22:51 +11:00
Eelco Dolstra
6bd0519918 Manual: Fix indent of config section 2015-12-10 16:06:12 +01:00
Eelco Dolstra
e115e3fd76 Manual: Rename file 2015-12-10 16:06:12 +01:00
Matthias C. M. Troffaes
e6046739cd doc/submitting-changes: mention master -> staging merge (see issue #11460) 2015-12-07 08:49:04 +00:00
Eelco Dolstra
f7c25bf9c2 Manual: Add a warning that overrideDerivation should not be used 2015-12-02 13:54:24 +01:00
Pascal Wittmann
56d3457c2f doc: --meta is not needed in the presence of --json 2015-11-29 21:51:22 +01:00
Luca Bruno
5a881a6fb1 doc: fix typo in language-support.xml 2015-11-26 20:19:11 +01:00
Domen Kožar
ce5b72e8f9 doc: fix setup.py develop reference 2015-11-26 18:49:14 +01:00
Domen Kožar
2e605199a7 buildPythonPacakage: update docs 2015-11-21 22:16:49 +01:00
Domen Kožar
a912c45ee2 buildPythonPackage: get rid of setupPyInstallFlags since there is no such thing 2015-11-21 21:44:12 +01:00
zimbatm
d46a1cc3f6 manual: typo fixes 2015-11-20 09:56:25 +00:00
William A. Kennington III
6602f49495 Revert "Revert "Merge pull request #9543 from NixOS/staging.post-15.06""
This reverts commit 741bf840da.

This reverts the fallout from reverting the major changes.
2015-11-14 12:32:51 -08:00
William A. Kennington III
8a44a36ca4 Merge branch 'master.upstream' into staging.upstream 2015-10-15 10:22:28 -07:00
Nikolay Amiantov
fa53fbe086 build-fhs-{chroot,user}env: document new extra bind mounts option 2015-10-11 17:53:03 +03:00
Eelco Dolstra
741bf840da Revert "Merge pull request #9543 from NixOS/staging.post-15.06"
This reverts commit f61176c539, reversing
changes made to a27ca029ee.

Conflicts:
	pkgs/development/libraries/ncurses/default.nix
2015-10-06 15:24:20 +02:00
Peter Simons
3f727911bf haskell-users-guide.md: document static linking 2015-10-02 08:29:50 +02:00
Peter Simons
a7840a9ce8 doc: generate haskell-users-guide.xml from Markdown input via Pandoc
Editing Docbook is no fun, IMHO, so I'd rather store the Haskell
documentation in Markdown format and use Pandoc to convert that into
Docbook as part of the build process.
2015-09-30 17:24:28 +02:00
Peter Simons
46f59a3a14 doc/default.nix: fix Emacs syntax highlighting (no functional change) 2015-09-30 17:24:28 +02:00
Thomas Tuegel
cbe318d531 Merge branch 'qt-5.5' 2015-09-27 16:07:05 -05:00
Thomas Tuegel
79be4a769f manual: document Qt packaging tools 2015-09-27 16:06:29 -05:00
Vladimír Čunát
6070cd09fc haskell: make ghc, cabal-install, and stack visible
Thanks to @peti. Close #10035.
2015-09-27 17:18:44 +02:00
Vladimír Čunát
1eb5566af5 doc/functions: fix a typo 2015-09-24 11:07:53 +02:00
Vladimír Čunát
76ef7a93e3 Merge: xlibs and x11 attribute cleanup
Frequently using multiple *almost* identical attributes is bad.
2015-09-23 10:42:34 +02:00
Eelco Dolstra
645441c207 hello/ex-2 -> hello 2015-09-22 20:23:23 +02:00
Jan Malakhovski
8358272046 doc: update haskell-users-guide.xml with ghcWithHoogle stuff 2015-09-19 19:45:32 +00:00
Eelco Dolstra
ec5b66eb4a Enable separate debug info
You can now pass

  separateDebugInfo = true;

to mkDerivation. This causes debug info to be separated from ELF
binaries and stored in the "debug" output. The advantage is that it
enables installing lean binaries, while still having the ability to
make sense of core dumps, etc.
2015-09-17 15:56:33 +02:00
Vladimír Čunát
88c9f8b574 xlibs: replace occurrences by xorg
This seems to have been confusing people, using both xlibs and xorg, etc.
- Avoided renaming local (and different) xlibs binding in gcc*.
- Fixed cases where both xorg and xlibs were used.
Hopefully everything still works as before.
2015-09-15 12:54:34 +02:00
Peter Simons
d6396cc5d8 doc: update haskell-users-guide.xml to reflect that we've update GHC 7.10.1 to 7.10.2 2015-09-09 21:30:42 +02:00
Hoang Xuan Phu
4f4bf1f79c add note about using profiledHaskellPackages 2015-08-31 18:55:42 +08:00
Rommel M. Martinez
23a00d212f doc/haskell: fix typos (close #9561) 2015-08-30 18:11:57 +02:00
Peter Simons
ab37ad22f7 doc: add "other resources" section to haskell-users-guide.xml 2015-08-28 22:59:29 +02:00
Nikolay Amiantov
f04db6d3e7 buildFHS*Env: add documentation 2015-08-26 20:34:13 +03:00
Domen Kožar
f044c31174 Merge pull request #9298 from abbradar/python-env
python: add .env for convenient nix-shell's
2015-08-18 13:09:04 +02:00
Nikolay Amiantov
89a2f87011 elm: add the platform and helpful scripts 2015-08-17 21:32:30 +03:00
Nikolay Amiantov
344e522166 python: add .env for convenient nix-shell's 2015-08-17 21:22:50 +03:00
Peter Simons
c90ed187de doc/haskell-users-guide.xml: fix "nix-store --repair-path" example 2015-08-15 21:18:02 +02:00
Robert Helgesson
c71d44c724 nixpkgs doc: add package notes for Eclipse 2015-08-10 23:12:04 +02:00
Eelco Dolstra
2cd7c1f198 Unify NixOS and Nixpkgs channel structure
This is primarily to ensure that

  -I nixpkgs=https://nixos.org/channels/nixos-unstable/nixexprs.tar.xz

and

  -I nixpkgs=https://github.com/NixOS/nixpkgs-channels/archive/nixos-unstable.tar.gz

and

  -I nixpkgs=https://nixos.org/channels/nixpkgs-unstable/nixexprs.tar.xz

behave consistently.

It also allows installing packages via "nix-env -iA nixos.<pkg>"
rather than "nixos.pkgs.<pkg>". It would be even better to allow
"nixpkgs.<pkg>", but that requires a change to nix-channel.

Fixes #7659.
2015-08-05 17:37:11 +02:00
Luca Bruno
5dfb469faf doc: document .overrideDerivation 2015-07-30 17:56:39 +02:00
Domen Kožar
8ac9c708b9 Merge pull request #8703 from Profpatsch/python-docs
language-support python: propagatedBuildInputs
2015-07-20 10:47:16 +01:00
Matthias Beyer
15be920354 doc: gnu hello is much simpler than cpio
This patch changes the documentation about simple packages. cpio was
listed as simplest possible package, which is not true anymore, gnu
hello is much simpler.
2015-07-17 17:00:20 +02:00
Cillian de Róiste
8a1a97c35c Move the submitting-changes down, after coding conventions 2015-07-12 13:35:56 +02:00
Cillian de Róiste
3a0707f0c7 Move the details from CONTRIBUTING.md to the manual #8734 2015-07-12 13:33:55 +02:00
Profpatsch
b30cab15ea language support python docs wrong statement
Remove wrong line about propagatedBuildInputs.
2015-07-12 13:07:39 +02:00
Pascal Wittmann
cdd999baee doc: document dontMoveSbin variable 2015-07-09 12:43:34 +02:00
Profpatsch
ef5d158e83 language-support python: propagatedBuildInputs
Explain difference between buildInputs and propagatedBuildInputs.
Shamefully steal wording from Perl.
2015-07-08 14:21:51 +02:00
Kosyrev Serge
5fee7af3ba ghc: add haskell.compiler.ghcNokinds, for Richard Eisenberg's 'nokinds' branch 2015-07-06 11:09:28 +03:00
Luca Bruno
e7d81a371b doc: make it clear the Contributing section is for the docs 2015-06-30 12:25:55 +02:00
Luca Bruno
e06f494a81 doc: document lib.makeOverridable 2015-06-30 12:19:49 +02:00
Luca Bruno
01ce5ce050 doc: document .override 2015-06-30 11:26:27 +02:00
Luca Bruno
36cd08e374 nixpkgs-manual: fix callouts 2015-06-30 11:04:46 +02:00
Edward Tjörnhammar
c45b5aba92 Document the different license base cases 2015-06-28 12:42:43 +02:00
Luca Bruno
7f5f9072ad all-packages.nix: Add pkgs.overridePackages 2015-06-26 15:08:11 +02:00
Damien Cassou
8297a9eef9 Change where window managers should be
This patch reflects current practice.

Fixes issue #8364.
2015-06-18 10:44:27 +02:00
Peter Simons
fdc1887a6e doc: add user's guide for the Haskell infrastructure
Resolves https://github.com/NixOS/nixpkgs/issues/4941.
2015-06-05 00:14:58 +02:00
Eelco Dolstra
07b212b09d Strip indentation from programlistings 2015-06-03 17:05:14 +02:00
Eelco Dolstra
35ff30c73f Streamline contributing section 2015-06-03 17:05:10 +02:00
Pascal Wittmann
9c983ade4d doc: fix references 2015-06-02 11:22:19 +02:00
Pascal Wittmann
53b5d946e1 doc: add section ids
This commit also use enforces consistent use of the prefixes "sec" for
section and "ssec" for subsection.
2015-05-31 18:41:34 +02:00
Allen Nelson
d2cbcc68be added documentation for makeWrapperArgs 2015-05-24 22:22:20 -05:00
Arseniy Seroka
4e838ed303 Merge pull request #6539 from jagajaga/documentation
add information about git-based pkgs
2015-05-21 19:57:53 +03:00