diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2023-02-07 14:24:19 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2023-02-07 14:24:19 +0000 |
| commit | c300cba6aaac98dd17b89cc55e5dbbd9e3970b18 (patch) | |
| tree | 8acf5196d21760764a7183119e959ec778da2902 | |
| parent | e697241c979603e828902177436c0b483ee780c8 (diff) | |
| download | docutils-c300cba6aaac98dd17b89cc55e5dbbd9e3970b18.tar.gz | |
Announce command-line usage pattern change.
Cf. [feature-requests:#36].
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9327 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
| -rw-r--r-- | docutils/RELEASE-NOTES.txt | 19 | ||||
| -rw-r--r-- | docutils/docs/user/tools.txt | 10 |
2 files changed, 27 insertions, 2 deletions
diff --git a/docutils/RELEASE-NOTES.txt b/docutils/RELEASE-NOTES.txt index 29d32f140..24539bad7 100644 --- a/docutils/RELEASE-NOTES.txt +++ b/docutils/RELEASE-NOTES.txt @@ -65,6 +65,25 @@ Drop support for Python 2.7 and 2.8 in Docutils 0.21. __ docs/user/html.html#html +* The command-line usage pattern will change: + + .. code:: diff + + - <toolname> [options] [<source> [<destination>]] + + <toolname> [options] source [source2 [source3 [...]]] + + * Remove short options ``-i`` and ``-o`` in Docutils 0.22. + Use the long equivalents ``--input-encoding`` and ``--output-encoding``. + + * Stop accepting the `<destination>` positional argument in Docutils 1.0. + Use output redirection ``>`` or the option ``--output=<destination>`` + (available since Docutils 0.20). + + * Accept more than one source document and the short option + ``-o`` for ``--output`` in Docutils 2.0 + + For the rationale, see https://clig.dev/#arguments-and-flags. + * `Input encoding`_: - Raise UnicodeError (instead of falling back to the locale encoding) diff --git a/docutils/docs/user/tools.txt b/docutils/docs/user/tools.txt index 9a9078e91..99979f242 100644 --- a/docutils/docs/user/tools.txt +++ b/docutils/docs/user/tools.txt @@ -14,9 +14,14 @@ .. note:: Docutils front-end tool names, install details and the set of - auto-installed tools will `change in Docutils 0.21`__. + auto-installed tools will change in Docutils 0.21. + + The command line usage pattern will change over the next releases. + + See `Future changes`__ in the RELEASE-NOTES. + +__ RELEASE-NOTES.html#future-changes - __ ../../RELEASE-NOTES.html#future-changes -------------- Introduction @@ -49,6 +54,7 @@ input (stdin) is used for the source. .. [#] The exceptions are buildhtml.py_ and rst2odt_prepstyles.py_. + Getting Help ============ |