summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-08-11doc/emacs: use define-key instead of hard-coding markupDavid Bremner
Add keys to index. Allow indexing of both keys and commands. Use standard typesetting for multiple keybindings.
2022-08-11doc/emacs: replace use of emacsvar with el:defcustomDavid Bremner
Mainly this allows dropping the ad-hoc directive emacsvar
2022-08-11doc/emacs: replace emacscmd with el:define-keyDavid Bremner
This allows us to eliminate the ad-hoc emacscmd directive / role, and improve indexing. doc/emacs: convert remaining uses of emacscmd to define-key This allows us to remove the no-longer used object type.
2022-08-11doc/emacs: split index category from labelDavid Bremner
A more verbose category is needed for the index, but not the description in the manual.
2022-08-11doc/emacs: drop domain labelDavid Bremner
This makes the generate info files somewhat less verbose, so that they say e.g. "Key Binding" instead of "Emacs Key Binding"
2022-08-11doc/elisp: replace label for Emacs commands and key bindings.David Bremner
In the notmuch doc index it is important to be clear which parts are Emacs related.
2022-08-11doc: copy elisp.py from flycheck, make availableDavid Bremner
This corresponds to flycheck commit 1702d2db3d8ba9bcb9b2bf810e791e907fcc3adc, which is apparently the last time this file was modified (2018). Embedding seems defensible since the file is evidently not changing that much, and we need to change some labels to make it fit with the not-just-emacs nature of notmuch docs.
2022-08-11doc: add some documentation about duplicate files.David Bremner
This is mainly motivated by the new emacs-UI features to select duplicates, but hopefully it will help demystify things for users of the CLI as well.
2022-08-06doc/notmuch: merge two sections on external commands.David Bremner
When adding the description of the propagation of NOTMUCH_CONFIG, I missed that there was already a section on external commands, with a different title.
2022-07-30doc/emacs: add docstring for notmuch-unthreaded-result-format.David Bremner
The main change is actually updating cross references.
2022-07-30doc/emacs: add docstring and example for n-tree-result-formatDavid Bremner
This example is based on one originally by Jon Hurst.
2022-07-30doc/emacs: add docstring and example for n-search-result-formatDavid Bremner
When the ability to use functions was added, this example was confined to a commit message, which is not user discoverable.
2022-07-30CLI/reply: support --duplicate argumentDavid Bremner
We want the reply used to match that shown e.g. in the emacs interface. As a first step provide that functionality on the command line. Schema does not need updating as the duplicate key was already present (with a constant value of 1).
2022-07-30CLI/show: initial support for --duplicate for (raw output only)David Bremner
Add command line argument --duplicate, analogous with that already supported for notmuch-search. Use of a seperate function for _get_filename is mainly a form of documentation at this point. md5sum is of course a weak hash, but it is good enough for this (non-adversarial) test suite use.
2022-07-15doc/emacs: add notmuch-show-empty-saved-searches to manualDavid Bremner
Answering a user question, I had to dig for this variable, but I think it is a reasonably common customization wish, particularly for users with custom count-functions.
2022-07-15doc/emacs: define and use emacsvar and emacscmd markupDavid Bremner
This makes it easier to navigate the merged index of all of the notmuch documentation.
2022-07-14doc: do not generate python module indexDavid Bremner
This currently seems unhelpful, and not generating it removes if from the navigation bar, which prevents mis-clicking.
2022-07-14doc: drop module index from ToCDavid Bremner
There is only one module listed, so the index is not useful.
2022-07-14doc: retitle notmuch-emacs manualDavid Bremner
This makes the HTML TOC read more naturally. Add a label to make cross referencing easier.
2022-07-14doc: reorganize sphinx toctreeDavid Bremner
This mainly affects the html output (although users generating epub or pdf would also notice a change). The goal is twofold: make the TOC a bit friendler and easier to navigate by introducing some hierarchy, and allow links for nmbug and notmuch-setup.
2022-07-14doc: improve config item labels in info outputDavid Bremner
Commit 306b7028d added the nmconfig role / directive. Unfortunately the default of using the directive name in texinfo output is pretty ugly, so attempt to make it more human readable by passing `objname` to add_object_type invocation.
2022-07-14doc/emacs: add discussion about notmuch-show performance.David Bremner
Most of the information is already in the docstrings, but hopefully by grouping it is more discoverable.
2022-07-14emacs/show: introduce notmuch-show-height-limitDavid Bremner
Analogous to notmuch-show-depth-limit, it requires a bit more calculation, but that cost seems dominated by the rendering cost.
2022-07-14emacs/show: obey notmuch-show-max-text-part-size for part 0David Bremner
This parameter was originally introduced to hide large attachements that happened to be text/plain. From a performance point of view, there is no reason not to also hide large message bodies.
2022-07-14emacs/show: optionally insert bodies of "deep messages" lazilyDavid Bremner
This leverages the machinery already there to insert buttons for attachments. A potential use-case is browsing the top layers of the tree to decide which of the lower subtrees to read.
2022-07-07CLI/git: add --format-version argument to init subcommandDavid Bremner
This is primarily intended to support testing upward compatibility with legacy repos.
2022-07-07CL/git: add format version 1David Bremner
The original nmbug format (now called version 0) creates 1 subdirectory of 'tags/' per message. This causes problems for more than (roughly) 100k messages. Version 1 introduces 2 layers of hashed directories. This scheme was chose to balance the number of subdirectories with the number of extra directories (and git objects) created via hashing. This should be upward compatible in the sense that old repositories will continue to work with the updated notmuch-git.
2022-07-03doc: replace symlink with copies for nmbug, notmuch-setupDavid Bremner
Previously only man page aliases were being added as symlinks. The addition to man_pages in conf.py automatically propagates to the list of generated info pages. Installation of the new pages is handled by existing recipes.
2022-06-25doc/sexp: document range queries.David Bremner
Give examples for date fields, as these are commonly useful for user queries.
2022-06-17CLI/git: add safety checks for checkout and commitDavid Bremner
Commits or checkouts that modify a large fraction of the messages in the database should be relatively rare (and in some automated process, probably non-existent). For initial setup, where such operations are expected, the user can pass --force.
2022-06-17CLI/git: support configuration for repo location / prefixDavid Bremner
This is probably more convenient than always passing a command line argument. Use notmuch-config for consistency with other notmuch CLI tools. Now that there is something relevant in the config files, test the --config option.
2022-06-17CLI/git: change defaults for repo and prefixDavid Bremner
The previous defaults were not suitable for personal (i.e. not bugtracking for notmuch development) use. Provide two ways for the user to select nmbug compatible defaults; command line argument and checking the name of the script.
2022-06-17doc/notmuch-git: initial documentationDavid Bremner
This is mainly derived from the various help outputs from the script, with some massaging of markup and addition of links.
2022-06-16emacs: use message-dont-reply-to-names when composing repliesjao
notmuch-mua functions for replies now use the built-in customizable variable message-dont-reply-to-names with the same semantics as message-mode.
2022-06-13CLI: document handling of --config for external commandsDavid Bremner
Create a section of the notmuch(1) manpage to have some place to put this documentation.
2022-05-29doc/emacs: document a few notmuch-hello customizable variables.David Bremner
A user asked about the thousands separator on IRC, and I had to check the source.
2022-05-20emacs: document/defcustom notmuch-multipart/alternative-discouragedDavid Bremner
This variable is important for people who want to change the default behaviour when displaying multipart/alternative messages. Previously it was undocumented. Add a defcustom to help users and copy some documentation from the wiki. The usual machinery of re-using docstrings is a bit tricky to use here because it mangles the example lisp code, and the link to the info node should not be in e.g. the html page. Add a simple test to make sure the switch from defvar to defcustom did not break something obvious.
2022-05-20doc: define and use semantic markup for configuration itemsDavid Bremner
This makes sure each configuration item is cross referenceable without extra markup, and also adds index entries.
2022-05-15doc/emacs: document notmuch-show-toggle-toggle-elide-non-matchingDavid Bremner
Recently there was a question on the mailing list about the existence of this function, so let us try to make it more discoverable.
2022-04-30doc/sexp-queries: be more consistent about ending example textDavid Bremner
Most, but not all of the the explanatory texts already end in '.'. This makes the remainder match.
2022-04-30doc/sexp-queries: fix exampleDavid Bremner
Update the explanatory text to match the query.
2022-04-30doc/sexp-queries: escape @ in non-verbatim textDavid Bremner
This prevents sphinx-doc from creating spurious mailto: links. Thanks to Jakub Wilk for telling me about the fix.
2022-04-15lib: add sexp: prefix to Xapian (infix) query parser.David Bremner
This is analogous to the "infix" prefix provided by the s-expression based query parser.
2022-03-19lib: do not phrase parse prefixed bracketed subexpressionsDavid Bremner
Since Xapian does not preserve quotes when passing the subquery to a field processor, we have to make a guess as to what the user intended. Here the added assumption is that a string surrounded by parens is not intended to be a phrase.
2022-02-26emacs: Document undo binding.David Bremner
This messes up whitespace, which will require a global change to fix.
2022-02-26emacs: add notmuch-tag-undoDavid Bremner
Keybindings are deferred to a future commit.
2022-02-25doc/emacs: add minimal documentation for notmuch-unthreaded mode.David Bremner
If nothing else it means the mode is discoverable by browsing the documentation, and also provides a target for links when enumerating modes.
2022-02-20doc: use hyperlinks for config options in notmuch-insert(1)David Bremner
The tradeoff is no bold/italic in the man pages to get actual hyperlinks in the html output.
2022-02-20doc: add configuration section to notmuch-insert(1)David Bremner
This is partially redudant given some existing cross references, but it is useful to have all of the config keys listed in one place, to help keep track of them if nothing else.
2022-02-20doc: add configuration section to notmuch-new(1)David Bremner
Increase discoverability.