diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 61887d7..8117da4 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -12,10 +12,10 @@ New functionality, massive documentation improvements, metadata support, and Spl Release v0.7.3 (2019-06-05) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Added the new ``ref:ksconf_cmd_xmlformat`` command. +- Added the new :ref:`ksconf_cmd_xml-format` command. - The ``ksconf xml-format`` command brings format consistency to your XML representations of Simple XML dashboards and navigation files by fixing indention and automatically adding ```` blocks, as needed, to reduce the need for XML escaping, resulting in more readable source. - - Additionally, a new pre-commit hook named `pchook_ksconf_xml-format` was added to leverage this new functionality. It looks specifically for xml views and navigation files based on path. This may also include Advanced XML, which hasn't been tested; So if you use Advanced XML, proceed with caution. + - Additionally, a new pre-commit hook named :ref:`ksconf-xml-format ` was added to leverage this new functionality. It looks specifically for xml views and navigation files based on path. This may also include Advanced XML, which hasn't been tested; So if you use Advanced XML, proceed with caution. - Note that this adds ``lxml`` as a packaging dependency which is needed for pre-commit hooks, but not strictly required at run time for other ksconf commands. This is NOT ideal, and may change in the future in attempts to keep ksconf as light-weight and standalone as possible. One possible alternative is setting up a different repo for pre-commit hooks. Python packaging and distribution tips welcome. - Fixed data loss bug in ``promote`` (interactive mode only) and improved some UI text and prompts. @@ -41,6 +41,8 @@ Release v0.7.2 (2019-03-22) Release v0.7.1 (2019-03-13) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + - Additional fixes for UTF-8 BOM files which appear to happen more frequently with ``local`` files on Windows. This time some additional unit tests were added so hopefully there are few regressions in the future. - Add the ``ignore-missing`` argument to :ref:`ksconf_cmd_merge` to prevent errors when input files are absent. diff --git a/docs/source/git.rst b/docs/source/git.rst index 0e86052..9c66f40 100644 --- a/docs/source/git.rst +++ b/docs/source/git.rst @@ -18,8 +18,6 @@ Hooks provided by ksconf Two hooks are currently defined by the ksconf repository: - .. _pchook_ksconf-check: - ksconf-check Runs :ref:`ksconf_cmd_check` to perform basic validation tests against all files in your repo that end with ``.conf`` or ``.meta``. @@ -27,8 +25,6 @@ Two hooks are currently defined by the ksconf repository: you'll be able to correct mistakes before bogus files are committed into your repo. If you're not sure why you'd need this, check out :ref:`Why validate my conf files? ` - .. _pchook_ksconf-sort: - ksconf-sort Runs :ref:`ksconf_cmd_sort` to normalize any of your ``.conf`` or ``.meta`` files which will make diffs more readable and merging more predictable. @@ -36,8 +32,6 @@ Two hooks are currently defined by the ksconf repository: For example, to manually organize :file:`props.conf` files, simply add the ``exclude`` setting. Example below. - .. _pchook_ksconf-xml-format: - ksconf-xml-format: Runs :ref:`ksconf_cmd_xml-format` to apply consistency to your XML representations of Simple XML dashboards and navigation files. Formatting includes appropriate indention and the automatic addition of ```` blocks, as needed,