summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Fix typosDimitris Apostolou2020-07-071-2/+2
|
* manual: remove "manifest" reference from the manualBen Boeckel2020-01-291-1/+1
| | | | Nothing else describes what a "manifest" is in user-facing docs.
* Merge pull request #1624 from bungeman/patch-1Jan Niklas Hasse2020-01-191-2/+2
|\ | | | | Recommend MD over MMD for header dependencies.
| * Recommend MD over MMD for header dependencies.bungeman2019-08-061-2/+2
| | | | | | The MMD flag will silently omit includes found through pointy brackets or system include paths. This can lead to issues not only when system headers change, but any paths included through the isystem flag. Because the isystem flag implicitly turns off warnings as errors it has often come to be used as a "not my code" flag used with local third party dependencies which may be frequently updated or changed for debugging. As a result, it is far safer to default to MD (which includes all include dependencies) in this example.
* | Add short doc for cleandead tool, fix #1716Jan Niklas Hasse2020-01-181-0/+3
| |
* | Add a short documentation for restat toolJan Niklas Hasse2019-12-231-0/+3
|/
* Merge pull request #1016 from moroten/docs-empty-rule-uptodateJan Niklas Hasse2019-07-091-0/+8
|\ | | | | Describe how to make a phony rule always up to date
| * Describe how to make a phony rule always up to dateFredrik Medley2017-08-161-0/+8
| | | | | | | | | | | | | | A phony rule with no input is always out of date. Describe how to make a rule always up to date. Signed-off-by: Fredrik Medley <fredrik.medley@gmail.com>
* | Resurrect the 'rules' tool.Nicolas Despres2019-05-091-0/+3
| | | | | | | | | | | | | | | | | | This tool is useful for writing shell completion script for tools expecting a rule name as argument. The tool was dropped by 34b46f28c. Fix #1024.
* | Document example dyndep use casesBrad King2019-04-181-0/+83
| | | | | | | | | | | | Show a simple example of Fortran module dependencies (this use case motivated the entire dyndep feature). Also show an example of tarball extraction, a case that few other buildsystems can handle cleanly.
* | Document `dyndep` binding behavior and the dyndep file formatBrad King2019-04-181-0/+67
| |
* | Update link to premakeddrone2019-04-101-1/+1
| |
* | Docs: Make builds reproducible by generating the same IDs from the same inputsGraham Christensen2019-02-071-0/+3
| |
* | Fix Fuchsia typoJan Niklas Hasse2019-02-051-1/+1
| |
* | Remove dead Chromium link, fix #1263Jan Niklas Hasse2018-11-251-2/+1
| |
* | Merge pull request #1484 from smeenai/gyp-to-gnJan Niklas Hasse2018-11-251-3/+3
|\ \ | | | | | | Change gyp to gn
| * | Change gyp to gnShoaib Meenai2018-10-191-3/+3
| | | | | | | | | | | | | | | Chrome has switched from gyp to gn, and Fuschia also uses it now. Note that the "Chromium Ninja documentation" link is dead, but I'm not sure what to replace it with. The closest I've found is https://chromium.googlesource.com/experimental/chromium/src/+/refs/wip/bajones/webvr/docs/ninja_build.md, but I'm not sure that's the original intended target.
* | | Merge pull request #1474 from mathstuf/win32-invalid-parameter-helpJan Niklas Hasse2018-11-161-1/+2
|\ \ \ | | | | | | | | Win32 invalid parameter help
| * | | manual: mention the "invalid parameter" caseBen Boeckel2018-11-091-1/+2
| |/ / | | | | | | | | | | | | This happens often enough and the error message is quite unhelpful. Mention this error explicitly in the documentation.
* | | Fix rendering of code block, fix #955Jan Niklas Hasse2018-11-141-1/+1
|/ /
* | Add _Available since Ninja 1.4._ to `deps` and `recompact`Nikolaus Wittenstein2017-08-301-2/+2
| |
* | Add `deps` and `recompact` tools to manualNikolaus Wittenstein2017-08-291-0/+5
|/ | | The `deps` tool in particular is very useful to know about.
* Change default NINJA_STATUS to [%f/%t]Colin Cross2016-04-281-1/+1
| | | | | | | | | | | | | | | | | | PR #999 changed the status line to be printed when edges finish on dumb teerminals, but the default status message includes the number of started edges, resulting in sequential status lines with identical edge counts. Change the default status to show the number of finished edges, which will keep the count incrementing on every line. This will slightly change the output on smart terminals. Previously a build that was just starting would show a count equal to the number of concurrent jobs, and a build waiting for the final jobs to finish would show a count equal to the total number of edges. Now a starting build will show 0, and build waiting for the final jobs will show a count less than the total number of edges by the number of remaining jobs. Fixes: #1142
* browse: support --port and --no-browser optionsPeter Wu2016-03-111-3/+7
| | | | | | | Add --port option to override the default port (8000). Add --no-browser option to avoid opening a web browser (useful over SSH). Make the target name optional, using "all" if omitted.
* browse.py: allow port override via environment variablePeter Wu2016-02-251-1/+2
|
* Merge pull request #1100 from nico/docNico Weber2016-02-031-9/+5
|\ | | | | Minor updates to the manual.
| * Minor updates to the manual.Nico Weber2016-02-031-9/+5
| | | | | | | | | | | | | | * Update link to Chromium's ninja docs (fixes #1038) * Update cmake URL to what it redirects to, and mention that ninja is well-supported on all platforms in newer CMake versions. * Let "others" link to the wiki page listing generators.
* | Add support for build statement implicit outputsBrad King2016-02-031-1/+26
|/ | | | | | | | | | | | | | | | | | Some build rules produce outputs that are not mentioned on the command line but that should be part of the build graph. Such outputs should not be named in the `$out` variable. Extend the build statement syntax to support specification of implicit outputs using the syntax `| out1 out2` after the explicit outputs and before the `:`. For example, compilation of a Fortran source file `foo.f90` that defines `MODULE FOO` may now be specified as: rule fc command = f95 -c $in -o $out build foo.o | foo.mod: fc foo.f90 The `foo.mod` file is an implicit output generated by the compiler based on the content of the source file and not mentioned on the command line.
* Merge pull request #1073 from ninja-build/manual-fontNico Weber2015-12-291-6/+0
|\ | | | | use the default font size for manual headings
| * use the default font size for manual headingsEvan Martin2015-12-161-6/+0
| | | | | | | | | | | | The third-level subsection headings were almost indistinguishable from the second-level ones. Fix this by just using the default styling.
* | Merge pull request #1074 from ninja-build/manual-commandNico Weber2015-12-291-6/+24
|\ \ | | | | | | add a section to the manual discussion the command= variable
| * | add a section to the manual discussing the command= variableEvan Martin2015-12-161-6/+24
| |/ | | | | | | | | This includes a mention of using cmd /c on Windows. This would have helped on issue #1070 for example.
* | drop a [horizontal] definition tableEvan Martin2015-11-171-1/+0
| | | | | | | | The two columns of the table run together, making it hard to read.
* | improve docs generation, including PDF outputEvan Martin2015-11-173-4/+36
| | | | | | | | | | | | - 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.
* | provide a better title for the manualEvan Martin2015-11-171-2/+2
| | | | | | | | In particular, this helps web search engines index it.
* | drop more references to github/martineEvan Martin2015-11-111-1/+0
| |
* | Describe why to use relative pathsFredrik Medley2015-09-031-0/+8
|/ | | | | | | | 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>
* Document the change from #921 in the manual.Nico Weber2015-06-191-1/+4
|
* Merge pull request #809 from andrey-malets/doc-for-first-outputNico Weber2014-12-041-0/+6
|\ | | | | Document target^ syntax.
| * Document target^ syntax.Andrey Malets2014-09-061-0/+6
| | | | | | | | Added a note into the documentation about interesting target^ syntax
* | CanonicalizePath handles \ on WindowsScott Graham2014-10-301-3/+1
|/
* reword manual for depfile/rspfile escaping changeNico Weber2014-05-241-9/+7
|
* Make "depfile=$out.d" work if $out contains escaped characters, rspfile too.Nico Weber2014-05-211-2/+4
| | | | | | | | | | | | | | 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).
* wip for console pool on windowsNico Weber2014-05-131-2/+0
|
* Introduce the "console" poolPeter Collingbourne2014-02-031-0/+17
| | | | | | | 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).
* add deps_prefix for localized /showIncludes' output parsingPeter Kümmel2013-10-181-1/+9
|
* Proof readingJohan Sundström2013-08-131-1/+1
|
* Mention pools in the discussion of ninja's toplevel declarations.Nico Weber2013-07-071-0/+4
|
* slightly smaller subsectionsEvan Martin2013-04-101-0/+3
|
* move pool docs down under "more details"Evan Martin2013-04-101-56/+55
| | | | | | 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.