From 0c45c00d5a226e35afc2b2cfefd5eee3d11c66de Mon Sep 17 00:00:00 2001 From: SeeSpotRun Date: Tue, 16 Mar 2021 05:50:05 +1000 Subject: [PATCH] Docs: update documentation for new --rank-by option --- CHANGELOG.md | 6 ++++++ docs/rmlint.1.rst | 3 ++- docs/tutorial.rst | 7 +++++-- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b8c2a88..179c9f83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. The format follows [keepachangelog.com]. Please stick to it. +## [2.11.0 Evolving Echidna -- unreleased] + +### Added + +* Implement --rank-by f option to rank originals by directory full path + ## [2.10.1 Ludicrous Lemur] -- 2020-06-13 ### Added diff --git a/docs/rmlint.1.rst b/docs/rmlint.1.rst index 9e33c2c2..f3da0ba2 100644 --- a/docs/rmlint.1.rst +++ b/docs/rmlint.1.rst @@ -441,7 +441,8 @@ Original Detection Options - **o**: keep file with lowest number of hardlinks outside of the paths traversed by ``rmlint``. - **O**: keep file with highest number of hardlinks outside of the paths traversed by ``rmlint``. - Alphabetical sort will only use the basename of the file and ignore its case. + Alphabetical sort [aA] will only use the basename of the file and ignore its case. + Alphabetical sort on dir [fF] uses the full path (excluding basename) and is case-sensitive. One can have multiple criteria, e.g.: ``-S am`` will choose first alphabetically; if tied then by mtime. **Note:** original path criteria (specified using `//`) will always take first priority over `-S` options. diff --git a/docs/tutorial.rst b/docs/tutorial.rst index faf78444..da68cb2d 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -516,7 +516,8 @@ Here's a table of letters you can supply to the ``-S`` option: ===== ========================================================================================== ===== ================================= **m** keep lowest mtime (oldest) **M** keep highest mtime (newest) -**a** keep first alphabetically **A** keep last alphabetically +**a** keep first basename alphabetically **A** keep last basename alphabetically +**f** keep first dir path alphabetically **F** keep last dir path alphabetically **p** keep first named path **P** keep last named path **d** keep path with lowest depth **D** keep path with highest depth **l** keep path with shortest basename **L** keep path with longest basename @@ -532,7 +533,9 @@ specified first in the rmlint command, then finally based on alphabetical order of file name. Note that "original directory" criteria (see below) take precedence over any ``-S`` options. -Alphabetical sort will only use the basename of the file and ignore its case. +Alphabetical sort on basename (a or A) will only use the basename of the file and ignore its case. +Alphabetical sort on dir path (f or F) will use the full path of the file's directory and is case-sensitive. + One can have multiple criteria, e.g.: ``-S am`` will choose first alphabetically; if tied then by mtime. **Note:** original path criteria (specified using `//`) will always take first priority over `-S` options.