| Commit message (Collapse) | Author | Age |
|---|
| |
|
|
|
|
| |
Add --keep option to keep any remaining stuff in index or file. We
could distinguish between failures to index and failures to apply tags
or maildir sync, but for simplicity just have one.
|
| |
|
|
|
|
|
| |
Although this manual is far from complete, it may be helpful for
someone. In particular building it as part of the standard build
process makes it easier to find problems when editing the
notmuch-emacs-manual.
|
| |
|
|
|
| |
Fix several typos, improve general wording and flow, and add some
information on notmuch-jump.
|
| |
|
|
| |
Some (older) Doxygen versions do not create such a temporary file.
|
| |
|
|
|
|
|
|
|
| |
There is a doxygen bug about these odd files,
https://bugzilla.gnome.org/show_bug.cgi?id=727796
But it isn't clear if / when a fix will be provided, so just delete it
to avoid e.g. confusing man-to-wiki.pl
|
| |
|
|
|
|
| |
Remove excess italics from doxygen output. It seems to make no
sense (and is certainly ugly) to italicize the first argument to the
.RI macro.
|
| |
|
|
|
| |
remove some obsolete tags for XML output (which we don't currently
generate in any case)
|
| |
|
|
|
| |
In order to support out of tree builds and avoid hardcoding version
number, generate `doc/config.dox` from configure.
|
| |\
| |
| |
| |
| | |
A point release is slowly being built on branch release. Merge those
changes into master.
|
| | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
Avoid:
$ make HAVE_SPHINX=1 sphinx-html
python ./doc/mkdocdeps.py ./doc doc/_build doc/docdeps.mk
sphinx-build -b html -d doc/_build/doctrees -q ./doc doc/_build/html
Making output directory...
WARNING: html_static_path entry '/home/wking/src/notmuch/notmuch/doc/_static' does not exist
because we have no static source in doc/_static.
|
| |\|
| |
| |
| | |
notmuch 0.18~rc1 release
|
| | | |
|
| |/ |
|
| |
|
|
|
| |
This build artifict messes up the packaging process for (at least)
Debian if not removed on clean.
|
| |
|
|
|
|
| |
Previously, this was a verbatim copy of the --format=json text.
Change it to instead reference the JSON text and actually describe how
the S-expression format works.
|
| | |
|
| |
|
|
| |
There were some extra line breaks and missing periods.
|
| |
|
|
|
| |
In addition to being generally more precise, this is explicit that
there is no charset conversion.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Avoid:
$ make HAVE_SPHINX=0 HAVE_RST2MAN=1 build-man
python ./doc/prerst2man.py ./doc doc/_build/man
Traceback (most recent call last):
File "./doc/prerst2man.py", line 65, in <module>
os.system('set -x; rst2man {0} {1}/{2}.{3}'
NameError: name 'os' is not defined
make: *** [doc/_build/man/man1/notmuch.1] Error 1
by using system directly. We don't need the 'os.' namespacing,
because the function was imported with:
from os import makedirs, system
|
| |
|
|
|
|
|
|
| |
Python 3 only supports the 0oXXX notation for octal literals [1,2],
which have also been supported in 2.x since 2.6 [2].
[1]: https://docs.python.org/3.0/whatsnew/3.0.html#integers
[2]: http://legacy.python.org/dev/peps/pep-3127/
|
| |
|
|
|
|
|
|
|
| |
Before this patch, the open was unnecessarily early and relied on the
process cleanup to close. Neither one of these was a real problem,
but PEP 343's context managers (which landed in Python 2.5) make
proper cleanup very easy.
[1]: http://legacy.python.org/dev/peps/pep-0343/
|
| |
|
|
|
|
|
|
|
|
| |
excefile is gone in Python 3 [1]. Instead of exec-ing the
configuration, it's easier to insert the source directory in Python's
path [2], and just import the configuration. With this change,
mkdocdeps.py is compatible with both Python 2 and 3.
[1]: https://docs.python.org/3.0/whatsnew/3.0.html#builtins
[2]: https://docs.python.org/3/library/sys.html#sys.path
|
| |
|
|
|
| |
Since 'notmuch new' now takes multiple options, it's confusing to show
only one of them in the summary.
|
| |
|
|
|
|
|
|
|
|
| |
The roff build rule builds all of the roff files in a single command.
Previously, this was expressed as a multi-target rule, but since this
is equivalent to specifying a copy of the rule for each target, make
-jN could start up to N parallel instances of this command. Fix this
by bottlenecking this rule through a single stamp file.
This also removes the unused man.stamp from CLEAN.
|
| |
|
|
|
|
| |
We rely completely on zlib to do the right thing in detecting gzipped
input. Since our dump format is chosen to be 7 bit ascii, this should
be fine.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
The main goal is to support gzipped output for future internal
calls (e.g. from notmuch-new) to notmuch_database_dump.
The additional dependency is not very heavy since xapian already pulls
in zlib.
We want the dump to be "atomic", in the sense that after running the
dump file is either present and complete, or not present. This avoids
certain classes of mishaps involving overwriting a good backup with a
bad or partial one.
|
| |
|
|
|
|
| |
While adding that fixed (also other) typos noticed by aspell(1) run,
and capitalized Emacs and (most) Notmuch terms to match how emacs
Info documentation seems to look in general.
|
| |
|
|
| |
a first step towards actually instally the API docs
|
| |
|
|
|
|
|
|
| |
The subtle part is adding .rst and .py files to vpath so they can be
used as dependencies without prefixing with $(srcdir)
We also change the interface to mkbuildeps.py: rather than getting the
containing directory from the conf file path, we go the other way.
|
| |
|
|
|
| |
Fix a particular egregious combination of format and string
concatenation.
|
| |
|
|
|
|
|
|
|
| |
Because sphinx-build does not provide a convenient way of listing
which builders exist, and some people actually have pre 1.0 sphinx, we
try loading a relevant python module.
Currently the assumption is that no python in path -> no sphinx-build
in path.
|
| |
|
|
|
|
|
|
|
| |
It turns out there was a reason the old man pages were stored in a man
compatible hierarchy, namely so that we could run man on them before
installing.
Hardcode doc build location into test suite. This isn't ideal, but
let's unbreak the test suite for now.
|
| |
|
|
|
|
|
|
| |
This helps avoid build artifacts (namely, nroff and gzipped-nroff man
pages) owned by root.
The variables allow choosing which generator to use for the man page.
These will be hooked to configure in a following commit.
|
| | |
|
| |
|
|
| |
Text from review by Austin Clements <amdragon@MIT.EDU>.
|
| |
|
|
| |
This avoids having to recreate the update-man-versions rule
|
| |
|
|
|
|
|
|
| |
The python script mkdocdeps.py is used to import the list of man pages
from the sphinx configuration to make.
This will delete the (release only) target update-man-versions. This
will be replaced in a followup commit.
|
| |
|
|
|
| |
Many people have docutils installed, but not sphinx. Allow these
people to build the man pages.
|
|
|
This is the output from sphinx-quickstart, massaged a bit, along with
our existing man pages converted to rst.
A skeleton notmuch-emacs manual is also included. It is not suitable
for end user use yet.
|
Jani Nikula
David Bremner
Austin Clements
Tomi Ollila
W. Trevor King
Austin Clements