[Kde-games-devel] Re: Review Request: Standardise formatting of command line options

[Parker Coates]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://svn.reviewboard.kde.org/r/5754/
-----------------------------------------------------------

(Updated 2010-11-02 13:52:35.419234)


Review request for KDE Games.


Changes
-------

Added Kajongg and application manuals.


Summary
-------

Tonight I noticed that Klickety was using --CamelCase for its command line options instead of KDE's "standard" --lower-case-hyphenated. When I asked Ni about it he said he just copied the formatting from KDiamond. This prompted me to take a look around the module and produce this patch. It corrects all the "non-standard" options I could find.

(Note that while lower-casing is near universal in KDE apps, hyphenation versus alloneword is not as clear cut. After an informal survey of some popular KDE applications it does seem that hyphenation is the more popular option.)

Since, Klickety is a new app, I believe its options should be fixed, but I'm not really sure about the rest. On the one hand, consistency is really nice to have. On the other, changing the options could theoretically break existing scripts and shortcuts. On the one hand, command line arguments (especially those included in this patch) are quite unlikely to be much used. On the other, if they're not heavily used, why would we care if they're consistent or not.

So I thought I'd throw up this patch as a point of conversation. What do people think.


Diffs (updated)
-----

  trunk/KDE/kdegames/doc/kajongg/index.docbook 1192115 
  trunk/KDE/kdegames/doc/klickety/index.docbook 1192115 
  trunk/KDE/kdegames/kajongg/src/kajongg.py 1192115 
  trunk/KDE/kdegames/kajongg/src/server.py 1192115 
  trunk/KDE/kdegames/katomic/main.cpp 1192115 
  trunk/KDE/kdegames/kdiamond/src/main.cpp 1192115 
  trunk/KDE/kdegames/kfourinline/src/main.cpp 1192115 
  trunk/KDE/kdegames/klickety/ksame.desktop 1192115 
  trunk/KDE/kdegames/klickety/main.cpp 1192115 
  trunk/KDE/kdegames/knetwalk/src/main.cpp 1192115 
  trunk/KDE/kdegames/kpat/main.cpp 1192115 
  trunk/KDE/kdegames/lskat/src/main.cpp 1192115 

Diff: http://svn.reviewboard.kde.org/r/5754/diff


Testing
-------

None. If we agree that this patch (or part of it) is worth doing I'll test that the renamed options work as expected.


Thanks,

Parker

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.kde.org/pipermail/kde-games-devel/attachments/20101102/9e0d3fdc/attachment-0001.htm