mirror of
https://blitiri.com.ar/repos/chasquid
synced 2025-12-16 14:27:01 +00:00
chasquid-util: switch --configdir into --config_dir and deprecate --configdir
There's an inconsistency between chasquid (which uses `--config_dir`) and chasquid-util (which uses `--configdir`). That is prone to cause confusion, so this patch renames chasquid-util's flag, leaving the old one as deprecated with a warning message. Closes https://github.com/albertito/chasquid/pull/60. Amended-by: Alberto Bertogli <albertito@blitiri.com.ar> Added test case for the deprecated option, adjusted commit message.
This commit is contained in:
committed by
Alberto Bertogli
parent
e5e7256d3e
commit
fa074ec16c
@@ -133,7 +133,7 @@
|
||||
.\" ========================================================================
|
||||
.\"
|
||||
.IX Title "chasquid-util 1"
|
||||
.TH chasquid-util 1 "2023-12-03" "" ""
|
||||
.TH chasquid-util 1 "2025-03-21" "" ""
|
||||
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||||
.\" way too many mistakes in technical documents.
|
||||
.if n .ad l
|
||||
@@ -185,9 +185,12 @@ security level downgrade. Talks to the running chasquid instance.
|
||||
.IP "\fBprint-config\fR" 8
|
||||
.IX Item "print-config"
|
||||
Parse and print the configuration in a human-readable way.
|
||||
.IP "\fB\-C\fR or \fB\-\-configdir=<path\fR>" 8
|
||||
.IX Item "-C or --configdir=<path>"
|
||||
.IP "\fB\-C\fR or \fB\-\-config_dir=<path\fR>" 8
|
||||
.IX Item "-C or --config_dir=<path>"
|
||||
Configuration directory.
|
||||
.IP "\fB\-\-configdir=<path\fR>" 8
|
||||
.IX Item "--configdir=<path>"
|
||||
Deprecated alias for \fB\-\-config_dir=<path\fR>.
|
||||
.SH "SEE ALSO"
|
||||
.IX Header "SEE ALSO"
|
||||
\&\fBchasquid\fR\|(1)
|
||||
|
||||
@@ -56,10 +56,14 @@ chasquid-util is a command-line utility for [chasquid(1)](chasquid.1.md) operati
|
||||
|
||||
Parse and print the configuration in a human-readable way.
|
||||
|
||||
- **-C** or **--configdir=<path**>
|
||||
- **-C** or **--config\_dir=<path**>
|
||||
|
||||
Configuration directory.
|
||||
|
||||
- **--configdir=<path**>
|
||||
|
||||
Deprecated alias for **--config\_dir=<path**>.
|
||||
|
||||
# SEE ALSO
|
||||
|
||||
[chasquid(1)](chasquid.1.md)
|
||||
|
||||
@@ -60,10 +60,14 @@ security level downgrade. Talks to the running chasquid instance.
|
||||
|
||||
Parse and print the configuration in a human-readable way.
|
||||
|
||||
=item B<-C> or B<--configdir=<path>>
|
||||
=item B<-C> or B<--config_dir=<path>>
|
||||
|
||||
Configuration directory.
|
||||
|
||||
=item B<--configdir=<path>>
|
||||
|
||||
Deprecated alias for B<--config_dir=<path>>.
|
||||
|
||||
=back
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
Reference in New Issue
Block a user