diff --git a/Documentation/redo-ood.md b/Documentation/redo-ood.md new file mode 100644 index 0000000..3719920 --- /dev/null +++ b/Documentation/redo-ood.md @@ -0,0 +1,59 @@ +% redo-ood(1) Redo 0.00 +% Avery Pennarun +% 2010-12-19 + +# NAME + +redo-ood - print the list of out-of-date redo targets + +# SYNOPSIS + +redo-ood + + +# DESCRIPTION + +redo-ood prints a list of all redo *target* files that +exist, but are out of date. + +Files that no longer exist might not be targets anymore; +you'll have to redo them for them to end up back in this +list. (For example, if you built a file and then removed +the file and its .do file, you wouldn't want it to show up +in this list.) + +If a .do script does not produce an output file (eg. +all.do, clean.do), it also does not show up in this list. + +Each filename is on a separate line. The filenames are not +guaranteed to be in any particular order. + +All filenames are printed relative the current directory. +The list is not filtered in any way; it contains *all* the +target filenames from the entire project. Remember that +the redo database may span more than just your project, so +you might need to filter the list before using it. (A +useful heuristic might be to remove any line starting with +'../' since it often refers to a target you don't care +about.) + +If you want a list of all targets, not just out-of-date +ones, use `redo-targets`(1). + + +# REDO + +Part of the `redo`(1) suite. + +# CREDITS + +The original concept for `redo` was created by D. J. +Bernstein and documented on his web site +(http://cr.yp.to/redo.html). This independent implementation +was created by Avery Pennarun and you can find its source +code at http://github.com/apenwarr/redo. + + +# SEE ALSO + +`redo`(1), `redo-targets`(1), `redo-sources`(1) diff --git a/Documentation/redo-sources.md b/Documentation/redo-sources.md new file mode 100644 index 0000000..1023ea6 --- /dev/null +++ b/Documentation/redo-sources.md @@ -0,0 +1,52 @@ +% redo-sources(1) Redo 0.00 +% Avery Pennarun +% 2010-12-19 + +# NAME + +redo-sources - print the list of all known redo sources + +# SYNOPSIS + +redo-sources + + +# DESCRIPTION + +redo-sources prints a list of all redo *source* files that +still exist. + +A source file is any file that has been listed as a +dependency (using `redo-ifchange`(1) or `redo-ifcreate`(1)) +but is not itself a target. A target is a file that +`redo`(1) can build using a .do script. + +Each filename is on a separate line. The filenames are not +guaranteed to be in any particular order. + +All filenames are printed relative the current directory. +The list is not filtered in any way; it contains *all* the +source filenames from the entire project. Remember that +the redo database may span more than just your project, so +you might need to filter the list before using it. + +If you want a list of targets instead of sources, use +`redo-targets`(1) or `redo-ood`(1). + + +# REDO + +Part of the `redo`(1) suite. + +# CREDITS + +The original concept for `redo` was created by D. J. +Bernstein and documented on his web site +(http://cr.yp.to/redo.html). This independent implementation +was created by Avery Pennarun and you can find its source +code at http://github.com/apenwarr/redo. + + +# SEE ALSO + +`redo`(1), `redo-targets`(1), `redo-ood`(1) diff --git a/Documentation/redo-targets.md b/Documentation/redo-targets.md new file mode 100644 index 0000000..4892a5a --- /dev/null +++ b/Documentation/redo-targets.md @@ -0,0 +1,64 @@ +% redo-targets(1) Redo 0.00 +% Avery Pennarun +% 2010-12-19 + +# NAME + +redo-targets - print the list of all known redo targets + +# SYNOPSIS + +redo-targets + + +# DESCRIPTION + +redo-targets prints a list of all redo *target* files that +still exist. + +Files that no longer exist might not be targets anymore; +you'll have to redo them for them to end up back in this +list. (For example, if you built a file and then removed +the file and its .do file, you wouldn't want it to show up +in this list.) + +If a .do script does not produce an output file (eg. +all.do, clean.do), it also does not show up in this list. + +The output of redo-targets might be useful in a +semi-automated `clean.do` target; you could delete all the +known targets, thus forcing them to be rebuilt next time. + +Each filename is on a separate line. The filenames are not +guaranteed to be in any particular order. + +All filenames are printed relative the current directory. +The list is not filtered in any way; it contains *all* the +target filenames from the entire project. Remember that +the redo database may span more than just your project, so +you might need to filter the list before using it. (A +useful heuristic might be to remove any line starting with +'../' since it often refers to a target you don't care +about.) + +If you want a list of only out-of-date targets, use +`redo-ood`(1). If you want a list of sources (dependencies +that aren't targets), use `redo-sources`(1). + + +# REDO + +Part of the `redo`(1) suite. + +# CREDITS + +The original concept for `redo` was created by D. J. +Bernstein and documented on his web site +(http://cr.yp.to/redo.html). This independent implementation +was created by Avery Pennarun and you can find its source +code at http://github.com/apenwarr/redo. + + +# SEE ALSO + +`redo`(1), `redo-ood`(1), `redo-sources`(1)