Nico Weber
c2e810ca43
Merge pull request #1073 from ninja-build/manual-font
...
use the default font size for manual headings
2015-12-29 10:08:42 -05:00
Nico Weber
a99dcc914c
Merge pull request #1074 from ninja-build/manual-command
...
add a section to the manual discussion the command= variable
2015-12-29 10:08:23 -05:00
Evan Martin
202fdd64c8
add a section to the manual discussing the command= variable
...
This includes a mention of using cmd /c on Windows.
This would have helped on issue #1070 for example.
2015-12-16 08:51:08 -08:00
Evan Martin
50a1cc39b7
use the default font size for manual headings
...
The third-level subsection headings were almost indistinguishable
from the second-level ones. Fix this by just using the default
styling.
2015-12-16 08:48:59 -08:00
Evan Martin
847089f959
drop a [horizontal] definition table
...
The two columns of the table run together, making it hard to read.
2015-11-17 14:13:44 -08:00
Evan Martin
a6859ac8af
improve docs generation, including PDF output
...
- Fix the manual build rules (missing the .xsl as an input).
- Add a README describing how the docs build works.
- Add rules that generate PDF, just 'cause we can.
2015-11-17 14:05:53 -08:00
Evan Martin
274db07276
provide a better title for the manual
...
In particular, this helps web search engines index it.
2015-11-17 14:02:43 -08:00
Evan Martin
b1129b15ff
drop more references to github/martine
2015-11-11 13:34:24 -08:00
Fredrik Medley
3f5b682bfd
Describe why to use relative paths
...
Ninja does resolve relative paths and file system links in paths.
Therefore, such paths pointing to the same file will not match and may
lead to an invalid dependency graph.
Signed-off-by: Fredrik Medley <fredrik.medley@gmail.com>
2015-09-03 21:45:42 +02:00
Nico Weber
ade82bd0b0
Document the change from #921 in the manual.
2015-06-18 17:28:20 -07:00
Nico Weber
725d38483d
Merge pull request #809 from andrey-malets/doc-for-first-output
...
Document target^ syntax.
2014-12-03 21:32:51 -08:00
Scott Graham
65151e7eef
CanonicalizePath handles \ on Windows
2014-10-30 15:34:25 -07:00
Andrey Malets
45aa2085f9
Document target^ syntax.
...
Added a note into the documentation about interesting target^ syntax
2014-09-06 23:31:39 +06:00
Nico Weber
385b7f39f5
reword manual for depfile/rspfile escaping change
2014-05-24 15:52:52 -07:00
Nico Weber
bc239cca4f
Make "depfile=$out.d" work if $out contains escaped characters, rspfile too.
...
Fixes #730 . This has always been broken, but due to #690 more paths are now
escaped (e.g. paths containing + characters, like file.c++). Also see
discussion in #689 .
The approach is to give EdgeEnv an enum deciding on whether or not to escape
file names, and provide functions that evaluate depfile and rspfile with that
set that to kNoEscape. (depfile=$out.d doesn't make sense on edges with
multiple outputs.)
This should be relatively safe, as $in and $out can't be used on edges, only
on rules (#687 ).
2014-05-21 15:18:01 -07:00
Nico Weber
47993664be
wip for console pool on windows
2014-05-13 12:37:31 -07:00
Peter Collingbourne
2832613dc7
Introduce the "console" pool
...
This is a pre-defined pool with a depth of 1. It has the special property
that any task in the pool has direct access to the console. This can be
useful for interactive tasks or long-running tasks which produce status
updates on the console (such as test suites).
2014-02-02 21:20:01 -08:00
Peter Kümmel
037b0934f9
add deps_prefix for localized /showIncludes' output parsing
2013-10-19 01:25:47 +02:00
Johan Sundström
3382976433
Proof reading
2013-08-12 18:47:06 -07:00
Nico Weber
8a3a941ef6
Mention pools in the discussion of ninja's toplevel declarations.
2013-07-07 12:23:56 -07:00
Evan Martin
07f16eb41e
slightly smaller subsections
2013-04-10 10:08:51 -07:00
Evan Martin
ec6b0e7af9
move pool docs down under "more details"
...
The earlier section is a tutorial-style overview. The latter section
is for side features like phony rules and header dependencies. Pools
fit in with the latter.
2013-04-10 10:03:55 -07:00
Evan Martin
8c0d41c7e1
more minor manual touchups
2013-04-10 10:02:27 -07:00
Evan Martin
6e5cd6f6c6
mention mtimes
2013-04-10 09:43:07 -07:00
Evan Martin
13c715c24d
monospace flags
2013-04-10 09:34:34 -07:00
Evan Martin
5bc973539d
more windows doc updates
2013-04-10 09:31:23 -07:00
Evan Martin
eaa4d6c22c
update some windows references in the docs
...
Drop the timing info, it's too variable to commit to a manual.
2013-04-09 15:30:02 -07:00
Evan Martin
87fdd8482d
bigger manual
2013-04-09 15:30:02 -07:00
Evan Martin
3e5dce7ce6
document deps
2013-04-09 09:33:35 -07:00
Evan Martin
cf741082aa
tag a feature with the right version number
2013-04-05 09:27:06 -07:00
Evan Martin
ecc876eb51
Merge pull request #513 from fifoforlifo/master
...
Adding elapsed time (%e) to NINJA_STATUS.
2013-03-11 13:47:37 -07:00
Avinash Baliga
5c132de2b7
Added %e to manual.asciidoc, fixed brace style.
2013-03-11 00:15:46 -05:00
Evan Martin
a3bf38cac7
Merge pull request #512 from pcc/compilation-database
...
Add compdb tool
2013-03-10 10:03:55 -07:00
Peter Collingbourne
e99c493bc7
Add compdb tool
...
This tool helps convert Ninja build files to a compilation database
of the form used by Clang tooling.
2013-03-09 19:22:58 -08:00
Evan Martin
dad0649d4b
Merge pull request #499 from lht/patch-1
...
Fix typo in manual
2013-03-09 16:50:34 -08:00
Martin Olsson
1d6e670975
Fix typo, s/verison/version/
2013-02-19 21:41:30 +01:00
Evan Martin
e758e8d0e0
manual: move in_newline to the reference
...
It's a detail, it doesn't belong in the brief tutorial overview.
2013-02-19 09:31:39 -08:00
Evan Martin
52ae6ddb18
add versioning notes to features in the manual
...
This helps guide which ninja version to depend on.
2013-02-17 11:22:37 -08:00
Evan Martin
d56f995ef0
make doc xrefs link to section headers
2013-02-17 11:16:23 -08:00
Haitao Li 李海涛
5f3429b14d
Fix typo in manual
2013-02-17 18:50:16 +08:00
Evan Martin
e6d618556c
rearrange env variable section layout
2013-02-16 17:32:42 -08:00
Evan Martin
d3c4cf1b36
move from asciidoc html to asciidoc -> docbook -> html
...
As best as I can tell this is the easiest way to customize
the asciidoc HTML output.
2013-02-16 17:13:10 -08:00
Evan Martin
0328a7bc9f
docs for ninja_required_version
...
(And some extra docs for top-level variables in general.)
2013-02-16 15:15:20 -08:00
Evan Martin
05736568b9
mark pools as experimental in the docs
2013-02-01 10:37:10 -08:00
Evan Martin
34b46f28c5
drop the "rules" tool completely
...
I had already broken this earlier, but the refactor of variable handling
broke it completely.
2012-12-29 12:34:25 -08:00
Evan Martin
94ea3e9d08
update docs to clarify scoping rules
2012-12-29 12:34:25 -08:00
yannicklm
6943f05372
NINJA_STATUS: add support of %p
for percentage
2012-12-14 22:26:39 +01:00
Robert Iannucci
3311c32f3e
Improve the manual documentation
2012-11-29 16:28:44 -08:00
Robert Iannucci
f2eeca20f4
add docs
2012-11-09 21:55:01 -08:00
Evan Martin
49dd59d707
document that \r and \t are disallowed
...
Finishes #394 .
2012-08-10 10:58:36 -07:00