summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2026-01-24doc/emacs: correct documentation of n-show-forward-messageDavid Bremner
Commit 3af10307d started a subsection on message level actions, but the author (yours truly) mistook their customized behaviour for the default.
2026-01-17doc/python: bump copyright yearDavid Bremner
2025-06-22doc/emacs: start subsection on message level actionsDavid Bremner
In particular this gives a place for documenting how to resume editing drafts.
2025-06-22doc/emacs: refactor navigation commandsDavid Bremner
The amount of space saved here is minimal, but I want to migrate to a more topic focused manual, as opposed to long alphabetical lists of commands.
2025-06-22doc/emacs: start a section on notmuch-message-modeDavid Bremner
This is mostly just copying docstrings, but putting them into sections makes them more discoverable.
2025-03-01docs: avoid nmbug in notmuch-git.1Michael J Gruber
These days, `nmbug` is `notmuch-git` with special defaults, so avoid the term `nmbug` in the doc when we talk about `notmuch-git` in general. Also, spell git in lower case (as we do for notmuch) except for the one case where we name the beast.
2025-01-26docs: add 2025 to copyright yearsDavid Bremner
2024-07-26config: allow custom separators in author listsLars Kotthoff
Allow distinguishing between commas separating authors and separating first and last names. Amended by db: reformat NEWS entry and commit message. Tweaked whitespace in lib/thread.cc.
2024-04-06emacs: Add new option notmuch-search-hide-excludedMohsin Kaleem
The new notmuch-search-hide-excluded option allows users to configure whether to show or hide excluded messages (as determined by search.exclude_tags in the local notmuch config file). It defaults to true for now to maintain backwards-compatibility with how notmuch-{search,tree} already worked. New commands notmuch-search-toggle-hide-excluded and notmuch-tree-toggle-exclude have also been added. They toggle the value of notmuch-search-hide-excluded for the search in the current search or tree buffer. It's bound to "i" in the respective keymaps for these modes. Lastly I've amended some calls to notmuch-tree and notmuch-unthreaded which didn't pass through the buffer local value of notmuch-search-oldest-first (and now notmuch-search-exclude). Examples of where I've done this include: + notmuch-jump-search + notmuch-tree-from-search-current-query + notmuch-unthreaded-from-search-current-query + notmuch-tree-from-search-thread A new test file for Emacs has been added which covers the usage of the new `notmuch-search-hide-excluded' option and interactively hiding or showing mail with excluded tags. These test cover the basic usage of the `notmuch-search-toggle-hide-excluded' command in notmuch-search, notmuch-tree and notmuch-unthreaded searches. These tests also cover the persistence of the current value of the hide-excluded mail option as a user switches from between these different search commands. [1]: id:87ilxlxsng.fsf@kisara.moe Amended-by: db, fix indentation in T461-emacs-search-exclude.sh
2024-03-09doc: update copyright years to include 2024David Bremner
2023-09-12build: clean up __pycache__ directoriesDavid Bremner
These are generated indirectly by certain uses of python in the build.
2023-08-24doc: update copyright date0.38_rc0David Bremner
2023-04-13doc: fix typosJakub Wilk
2023-04-02lib: index attachments with mime types matching index.as_textDavid Bremner
Instead of skipping indexing all attachments, we check of a (user configured) mime type that is indexable as text.
2023-02-20emacs: notmuch-tree-outline-modejao
With this mode, one can fold trees in the notmuch-tree buffer as if they were outlines, using all the commands provided by outline-minor-mode. We also define a couple of movement commands that, optional, will ensure that only the thread around point is unfolded. The implementation is based on registering a :level property in the messages p-list, that is then used by outline-minor-mode to to recognise headers. Amended by db: Copy docstring to manual and edit for presentation. Add two tests. Fix typo "wether".
2022-12-03doc: mark `--output=summary` as defaultMichael J Gruber
`notmuch search` behaves differently depending on the output option: It either outputs information pertaining to all threads with matching messages (summary, threads) or to all matching messages (messages, files, tags). The man page refres solely to the former in the main description. Help the user by clearly marking `summary` as the default output option. Signed-off-by: Michael J Gruber <git@grubix.eu>
2022-11-05cli: add options --offset and --limit to notmuch showRobin Jarry
notmuch search does not output header values. However, when browsing through a large email corpus, it can be time saving to be able to paginate without running notmuch show for each message/thread. Add --offset and --limit options to notmuch show. This is inspired from commit 796b629c3b82 ("cli: add options --offset and --limit to notmuch search"). Update man page, shell completion and add a test case to ensure it works as expected. Cc: Tim Culverhouse <tim@timculverhouse.com> Cc: Tomi Ollila <tomi.ollila@iki.fi> Signed-off-by: Robin Jarry <robin@jarry.cc>
2022-09-03lib: add field processor for lastmod: prefixDavid Bremner
By sharing the existing logic used by the sexp query parser, this allows negative lastmod revisions to be interpreted as relative to the most recent revision.
2022-09-03lib/sexp: provide relative lastmod queriesDavid Bremner
Test the relatively trivial logic changes for the sexp query parser first before refactoring that logic to share with the infix query parser.
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.