Commit graph

31 commits

Author SHA1 Message Date
Avery Pennarun
4008ce4a91 Change license to Apache 2.0.
Mailing list discussion was here:
https://groups.google.com/forum/#!topic/redo-list/wLMZMxtn4wo

Several more contributors replied to me personally to say that they
don't have a problem with the change (and several consider the change
to be an improvement).

The overwhelming majority of everything in the redo repo was written by
me, so I have the right to change the license unilaterally anyway,
subject to a few rules.  Since the new license actually removes
licensing/usage restrictions for everyone, this should be no problem.
2018-11-26 17:04:31 -05:00
Avery Pennarun
3b305edc7e Cookbook: add an example of using default.do for text processing. 2018-11-26 15:24:41 -05:00
Avery Pennarun
d663c9b67d First cookbook example for the docs: Hello World in C. 2018-11-24 14:36:02 -05:00
Avery Pennarun
0ce8ceddcb Run mkdocs only after generating the rest of the doc files.
This avoids a mkdocs bug where mkdocs will (rarely) see redo temp files
in its directory list, but they're gone by the time it tries to open
them, so it aborts with an exception.
2018-11-21 20:59:17 -05:00
Avery Pennarun
69890d0c57 Documentation: add link to github search; clarify .do.do question. 2018-11-21 07:11:46 -05:00
Avery Pennarun
1b616ddcbb Improved documentation.
Removed the Cookbook link for now, since it's empty.
2018-11-20 09:50:37 -05:00
Avery Pennarun
6ad0b032d4 redo-log: add man page. 2018-11-19 19:32:50 -05:00
Avery Pennarun
d0607d0091 Refactor the huge README.md into the more structured mkdocs.
I also cleaned up the installation section and added links to various
competing redo implementations.

The new README.md is basically just link to the docs on
readthedocs.org, and a link to the mailing list.

These docs need a *lot* more work, but this is enough of an improvement
that I'll commit it anyway for now.
2018-11-16 05:22:09 -05:00
apenwarr
bde3b5526f
Merge pull request #22 from SeamusConnor/master
Replaced all instances of 'python' with 'python2'

I think it's quite dumb that arch linux *ever* changed the default /usr/bin/python to python3, but oh well.  This patch seems to be okay now that even debian provides a /usr/bin/python2 symlink for the last several years.
2018-11-16 02:29:12 -05:00
Avery Pennarun
baae4fe213 Move mkdocs.yml into root directory, so readthedocs.org will work. 2018-11-16 01:14:15 -05:00
Avery Pennarun
4cf156e930 Generate a basic documentation website with the mkdocs toolkit.
No content yet other than man pages.  To make the man pages render
nicely in mkdocs, I removed the static %-headers and put the code for
them into default.md.tmp.do instead.  That way, the raw input redo-*.md
files will look right in mkdocs.
2018-11-16 00:50:18 -05:00
Seamus Connor
190b4c34ff Replaced all instances of 'python' with 'python2'
On systems where 'python' refers to python3, redo
failed to launch. All invocations of python have been
made explicitly python2 invocations. All tests pass
on an Arch Linux system as of this commit.
2018-11-14 10:52:09 -08:00
Avery Pennarun
f835becde4 redo-whichdo: updated output format.
The new format is just a list of .do files we tried, with a newline
after each one.  If we successfully found a .do file, we exit 0, else
we exit 1.

As discussed on the redo-list mailing list, it's easier to parse
without the extra cruft.  This makes users figure out $1 and $2
themselves, but that's not very hard, and maybe for the best.
2018-11-02 02:20:52 -04:00
Avery Pennarun
c724523473 Docs: Add missing commands to redo.md, and add redo-whichdo.md. 2018-10-11 05:56:21 -04:00
Avery Pennarun
84fb972fb7 Documentation: Fix some markdown formatting bugs. 2018-10-11 05:56:21 -04:00
Avery Pennarun
2affe20fb2 redo.me: missing .do in do search path description.
[Noticed by mait on github.]
2018-10-11 03:34:25 -04:00
Robert L. Bocchino Jr
63f9dcb640 Remove deprecated old-args feature. 2018-10-11 03:28:05 -04:00
Avery Pennarun
21f88094d5 Change definitions of $1,$2,$3 to match djb's redo.
If you use "redo --old-args", it will switch back to the old
(apenwarr-style) arguments for now, to give you time to update your .do
scripts.  This option will go away eventually.

Note: minimal/do doesn't understand the --old-args option.  If you're using
minimal/do in your project, keep using the old one until you update your use
of $1/$2, and then update to the new one.

apenwarr-style default.o.do:
   $1      foo
   $2      .o
   $3      whatever.tmp

djb-style default.o.do:
   $1      foo.o
   $2      foo
   $3      whatever.tmp

apenwarr-style foo.o.do:
   $1      foo.o
   $2      ""
   $3      whatever.tmp

djb-style foo.o.do:
   $1      foo.o
   $2      foo.o  (I think?)
   $3      whatever.tmp
2011-12-31 02:49:39 -05:00
Avery Pennarun
0670f78b96 md-to-man.do: suggest how to install markdown/BeautifulSoup
...since they aren't included by default on MacOS X, but easy_install can
easily get them for you.
2011-12-31 02:49:39 -05:00
Avery Pennarun
656c3c583c Docs: recommend adding redo-ifchange with a lot of targets at a time.
Some people don't know to do this, and their scripts are unnecessarily slow
because of it.
2011-05-08 04:25:51 -04:00
Avery Pennarun
2260bdd30f md2man: fix compatibility problem with python-markdown 1.6.
Symptom: the following error message when building redo.1:

	ValueError: non-man-compatible html tag u'br'
2011-03-10 19:49:18 -08:00
Avery Pennarun
a2bce72255 Simplify autodependency examples.
Turns out we don't need sed to process the output of gcc -MD.  We can just
do this:

	read DEPS <filename.deps

The 'read' command in sh actually handles backslashes correctly, so we don't
have to sed them out after all.  And then a simple ${DEPS#*:} removes the
"target:" prefix from the dependency line, and we're done!
2011-02-21 04:00:53 -08:00
Avery Pennarun
b43317bb83 md-to-man.do: remove leftover pandoc cruft.
Reported by Jimmy Tang on the mailing list.
2011-01-31 04:12:31 -08:00
Avery Pennarun
e174b09d5f Replace pandoc-based md-to-man conversion with a custom python script.
Hopefully this will appease the people who can't install pandoc on MacOS.
2011-01-29 23:27:23 -08:00
Avery Pennarun
5ea0cb01f5 version/gitvars: use redo-always if using git commands.
Otherwise we won't rebuild files when the commit id changes.
2011-01-18 00:55:25 -08:00
Avery Pennarun
94b34ea031 Generate redo version codes in Documentation/*.1 automatically.
We have to go through some pretty scary gyrations to extract this
information from git, but it can be done.  This works with both tarballs
generated by 'git archive', or with your local git repo.

(Requested by 'David' on the mailing list.)
2011-01-17 23:01:40 -08:00
Avery Pennarun
897c218f85 redo.md: explain .do file search-parent-dirs feature. 2011-01-16 16:33:22 -08:00
Michael Stone
62fe9a0df5 md-to-man.do: redo-ifcreate on possible paths to pandoc
This way, if you run

  ./redo
  $PKGMGR install pandoc
  ./redo

you'll still wind up with man pages.
2011-01-16 16:21:48 -08:00
Avery Pennarun
2618ebfafb Man pages for redo-targets, redo-sources, redo-ood. 2010-12-19 04:11:05 -08:00
Avery Pennarun
ca7a1de4e3 Add Documentation/git-{import,export}.do scripts.
These export and import, respectively, the generated man pages to/from the
git branch called 'man'.  You can use it to retrieve the .1 files if you
don't have a working pandoc.
2010-12-19 01:05:52 -08:00
Avery Pennarun
4b48448233 Add a bunch of manpages. 2010-12-12 02:12:21 -08:00