[gentoo-portage-dev] [PATCH] repoman: declare '-x', '--xmlparse' command line options obsolete

[gentoo-portage-dev] [PATCH] repoman: declare '-x', '--xmlparse' command line options obsolete

[Göktürk Yüksek]

Repoman pulls in lxml unconditionally now and performs metadata checks
by default. This behavior makes these command line options obsolete
since forcing the default makes little sense. Declare them obsolete
instead of removing them for backwards compatibility.

Signed-off-by: Göktürk Yüksek <gokturk@gentoo.org>
---
 repoman/man/repoman.1            | 3 +--
 repoman/pym/repoman/argparser.py | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/repoman/man/repoman.1 b/repoman/man/repoman.1
index e2b9c66..fc5c52d 100644
--- a/repoman/man/repoman.1
+++ b/repoman/man/repoman.1
@@ -59,8 +59,7 @@ Be less verbose about extraneous info
 \fB-p\fR, \fB--pretend\fR
 Don't commit or fix anything; just show what would be done
 .TP
-\fB-x\fR, \fB--xmlparse\fR
-Forces the metadata.xml parse check to be carried out
+\fB-x\fR, \fB--xmlparse\fR (OBSOLETE)
 .TP
 \fB-v\fR, \fB--verbose\fR
 Displays every package name while checking
diff --git a/repoman/pym/repoman/argparser.py b/repoman/pym/repoman/argparser.py
index 2d56a87..3d35b6a 100644
--- a/repoman/pym/repoman/argparser.py
+++ b/repoman/pym/repoman/argparser.py
@@ -117,7 +117,7 @@ def parse_args(argv, qahelp, repoman_default_opts):
 	parser.add_argument(
 		'-x', '--xmlparse', dest='xml_parse', action='store_true',
 		default=False,
-		help='forces the metadata.xml parse check to be carried out')
+		help='(OBSOLETE)')
 
 	parser.add_argument(
 		'--if-modified', choices=('y', 'n'), default='n',
-- 
2.7.3

[gentoo-portage-dev] Re: [PATCH] repoman: declare '-x', '--xmlparse' command line options obsolete

[Duncan]

Göktürk Yüksek posted on Thu, 19 May 2016 18:45:29 -0400 as excerpted:

> Repoman pulls in lxml unconditionally now and performs metadata checks
> by default. This behavior makes these command line options obsolete
> since forcing the default makes little sense. Declare them obsolete
> instead of removing them for backwards compatibility.

I like the general idea, but not the implementation. =:^(

Example...

> -\fB-x\fR, \fB--xmlparse\fR
> -Forces the metadata.xml parse check to be carried out
> +\fB-x\fR, \fB--xmlparse\fR (OBSOLETE)


Often I'll find some online resource that recommends some command, but I 
(arguably wisely!) prefer to check the manpage to see what a command and 
its recommended options actually do, as opposed to just running it.  That 
way, in addition to protecting myself from rm -rf .* type advice as 
sometimes found online, I learn as I go and can then apply the new 
knowledge to similar situations, instead of being lost when an arbitrary 
command copied without understanding doesn't work.

Or maybe I'm simply trying to fix an old, poorly documented script that 
just broke, and am trying to figure out what some command therein 
actually does.

The problem is outdated options with no hint as to what they actually did 
before they were obsoleted and how to proceed with updating them for use 
with newer versions.  Were they obsoleted by more flexible options so the 
old version isn't needed but I need to figure out what new option to use 
and its format?  Is that behavior now the default?  Was that 
functionality removed and thus is no longer available?

So please, don't just declare it obsolete without saying what it actually 
did and if it applies, what the current equivalent might be.  Doing so is 
if anything even more frustrating to someone trying to figure out what 
the option actually did, than removing it from the documentation entirely!

So, perhaps (I'm not going to attempt formatting)...

--xmlparse (Obsolete, formerly forced a metadata.xml parse check but 
that's now default behavior.)

That way, anyone seeing the option somewhere in old code will still be 
able to lookup what it did, and know that they can simply mentally ignore 
that option when mentally tracing the old code in their head and delete 
it in their updated version, because it's now the default.

-- 
Duncan - List replies preferred.   No HTML msgs.
"Every nonfree program has a lord, a master --
and if you use the program, he is your master."  Richard Stallman

Re: [gentoo-portage-dev] [PATCH] repoman: declare '-x', '--xmlparse' command line options obsolete

[Alexander Berntsen]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Don't remove the description of what it did. Just declare it
deprecated.

- -- 
Alexander
bernalex@gentoo.org
https://secure.plaimi.net/~alexander
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCgAGBQJXPtSZAAoJENQqWdRUGk8B6QIP/A5MeyiDS4OPPieZwtVg7HcK
ifaoKoXL3okzAI9lejBev+7WSk19fo0BRyOgZUd1qzA6i2UHf9+RERMYGTxA+swX
qUOFwj+sF7piClaJp6QJy6R2lnlDgUn4V1q+UsNRxuOa+1vKUO+jRt8R9dsPDHtz
/Mfr94zesfLpg/R6l9ALqQHbTwCpakrS1o5LBzlwxXq+waVRaEAcmOmpecgosPcQ
AQsfKvGqdzG8m+m8TJkYsaNRsAVp5iml1L8EMpkMXzy7hbzWsWmi4uqtahpB7Lma
wxkfc4bfjVfJJHsJp1cg18klIqCJY9CP6AbYYB8w7eLkyVTQGIpZu303WJ5MSc+z
B2kMyCF4fLyG/UnKC5ae7jkUowXDjnmir17mVJQpqQ3W4w/oRJBhEzLRwp0YhN8G
BV7VcVFRs2t6FA6EGh+ieWNFl1YszijJmGWwV5t+t7FlBfArq4Srm/KdSfA+6WKP
VXLVKR41YUceiG2OZDWe4/sB6bDHjW0b6QFqgR6Ux58MmDP9llsK1vB4mMGBLteE
/SPs+IvpbLZQF5WuPZwARq8aLAcPHEbP4PwvH2kGqaOA0JPiHf7TOJGWEt/S41mr
iFFT95qZDDX5gPzlEBQi6sD6yPRiY3kEgjclCNE/1K9RyruwawLhFVnZJ/WXjabs
9Z3GF8dC0FgSiwu2jB+T
=taOP
-----END PGP SIGNATURE-----