Patch to improve generation of edition and validation tool for /etc/LCDd.conf

Dominique Dumont <[email protected]> Sun, 23 Oct 2011 17:58:40 +0200

Newsgroups	gmane.comp.sysutils.lcdproc
Message-ID	<[email protected]>

Le Thursday 21 July 2011 22:45:23, Markus Dolze a écrit :
> On 20.07.2011 18:38, Dominique Dumont wrote:
> > Can I propose patches to improve LCDd.conf comments in this way ? 
> 
> Hello,
> 
> yes, please do so.

Hello

Here are 2 patches against CVS head to improve the generation of a 
configuration editor for lcdproc. [1]

The first patch (comments) modifies a few comments to:
- put documentation before the lines used to generate parameters. 
- avoid parameter duplication in configurartion tools

The second patch (fix-square-brackets) modifies the content of doc declared 
between square brackets to make them usable by the configuration 
generator. Unparsable user information was moved outside the brackets. 
I've taken care not to remove information. 

Except in the following ambiguous line:

  [default: true (= pixel addressable); legal: yes, no]

In this case, "true" is not in the list of legal parameters. So I've removed 
"legal: yes, no". I hope this is right

All the best

Dominique

[1] https://ddumont.wordpress.com/2011/06/29/new-configuration-editor-for-lcdproc/
--
http://config-model.wiki.sourceforge.net/ -o- http://search.cpan.org/~ddumont/
http://www.ohloh.net/accounts/ddumont     -o- http://ddumont.wordpress.com/

_______________________________________________
LCDproc mailing list
[email protected]
http://lists.omnipotent.net/mailman/listinfo/lcdproc

comments (text/x-patch, 1.1 KB)

--- a/LCDd.conf
+++ b/LCDd.conf
@@ -115,13 +115,13 @@
 #ScrollDownKey=Down
 
 # If you have only 4 keys, you can choose to use this:
-#ToggleRotateKey=Enter
-#PrevScreenKey=Up
-#NextScreenKey=Down
+# ToggleRotateKey=Enter
+# PrevScreenKey=Up
+# NextScreenKey=Down
 
 # If you have only 3 keys, you can choose to use this:
-#ToggleRotateKey=Enter
-#PrevScreenKey=Up
+# ToggleRotateKey=Enter
+# PrevScreenKey=Up
 
 
 
@@ -131,20 +131,27 @@
 # will be reserved exclusively, the others work in shared mode.
 
 # The following works excellent with 4 keys or more.
-MenuKey=Escape
-EnterKey=Enter
-UpKey=Up
-DownKey=Down
+# MenuKey=Escape
+# EnterKey=Enter
+# UpKey=Up
+# DownKey=Down
+
 # If you have 6 keys you may define these as well
-#LeftKey=Left
-#RightKey=Right
+# LeftKey=Left
+# RightKey=Right
 
 # If you have only 3 keys, you could use something like this:
-#MenuKey=Escape
-#EnterKey=Enter
-#DownKey=Down
+# MenuKey=Escape
+# EnterKey=Enter
+# DownKey=Down
 
 
+MenuKey=Escape
+EnterKey=Enter
+UpKey=Up
+DownKey=Down
+LeftKey=Left
+RightKey=Right
 
 ### Driver sections are below this line, in alphabetical order  ###

fix-square-brackets (text/x-patch, 5.4 KB)

--- a/LCDd.conf
+++ b/LCDd.conf
@@ -182,7 +182,7 @@
 # This value is used when the display is normally
 # switched off in case LCDd is inactive
 OffBrightness=0
-# Set the communication speed [default: 9600; legal: 1200, 2400, 9600, 19200 or 115200]
+# Set the communication speed [default: 9600; legal: 1200, 2400, 9600, 19200, 115200]
 Speed=9600
 # Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
 NewFirmware=no
@@ -229,7 +229,7 @@
 #Size=20x4
 
 # Override the default communication speed known for the selected model.
-# [default: depending on model; legal: 19200, 115200]
+# Default value depends on model [legal: 19200, 115200]
 #Speed=115200
 
 
@@ -270,7 +270,10 @@
 # Select the output device to use [default: /dev/lcd]
 Device=/dev/ttyUSB0
 
-# Select the LCD size [default: depending on model: 12232: 20x4, 12832: 21x4, 1602: 16x2]
+# Select the LCD size. Default depends on model: 
+# 12232: 20x4 
+# 12832: 21x4 
+# 1602: 16x2
 Size=20x4
 
 # Set the communication speed [default: 19200; legal: 9600, 19200]
@@ -454,7 +457,7 @@
 # Select what type of connection. See documentation for types.
 ConnectionType=4bit
 
-# Port where the LPT is [usual: 0x278, 0x378 and 0x3BC]
+# Port where the LPT is. Usual value are: 0x278, 0x378 and 0x3BC
 Port=0x378
 
 # Device of the serial interface [default: /dev/lcd]
@@ -482,7 +485,7 @@
 OutputPort=no
 
 # Specifies if the last line is pixel addressable or it controls an
-# underline effect. [default: true (= pixel addressable); legal: yes, no]
+# underline effect. [default: true] (true = pixel addressable)
 #Lastline=true
 
 # Specifies the size of the LCD.
@@ -503,8 +506,9 @@
 
 # Character map to to map ISO-8859-1 to the LCD's character set
 # [default: hd44780_default; legal: hd44780_default, hd44780_euro, ea_ks0073,
-# sed1278f_0b, (hd44780_koi8_r, hd44780_cp1251, hd44780_8859_5, upd16314 if
-# compiled with additional charmaps)]
+# sed1278f_0b, hd44780_koi8_r, hd44780_cp1251, hd44780_8859_5, upd16314 ]
+# (hd44780_koi8_r, hd44780_cp1251, hd44780_8859_5 and upd16314 are possible if
+# compiled with additional charmaps)
 CharMap=hd44780_default
 
 # If your display is slow and cannot keep up with the flow of data from
@@ -561,7 +565,7 @@
 #ExtendedMode=yes
 
 # Specifies if the last line is pixel addressable or it controls an
-# underline effect. [default: true (= pixel addressable); legal: yes, no]
+# underline effect. [default: true] (true = pixel addressable)
 #Lastline=true
 
 
@@ -576,18 +580,23 @@
 Size=16x2
 
 # Character map to to map ISO-8859-1 to the displays character set.
-# [default: none; legal: none, hd44780_euro, (upd16314, hd44780_koi8_r,
-# hd44780_cp1251, hd44780_8859_5 if compiled with additional charmaps)]
+# [default: none; legal: none, hd44780_euro, upd16314, hd44780_koi8_r,
+# hd44780_cp1251, hd44780_8859_5 ] (upd16314, hd44780_koi8_r,
+# hd44780_cp1251, hd44780_8859_5 are possible if compiled with additional charmaps)
 CharMap=hd44780_euro
 
 ## Soundgraph iMON LCD ##
 [imonlcd]
-# Specify which iMon protocol should be used [legal: 0=15c2:ffdc device,
-# 1=15c2:0038 device; default: 0]
+# Specify which iMon protocol should be used 
+# [legal: 0, 1; default: 0]
+# Choose 0 for 15c2:ffdc device,
+# Choose 1 for 15c2:0038 device
 Protocol=0
 
-# Set the exit behavior [legal: 0=leave shutdown message, 1=show the big clock,
-# 2=blank device; default: 1]
+# Set the exit behavior [legal: 0-2; default: 1]
+# 0 means leave shutdown message, 
+# 1 means show the big clock,
+# 2 means blank device
 #OnExit=2
 
 # Select the output device to use [default: /dev/lcd0]
@@ -602,8 +611,9 @@
 # Set the backlight state [default: on; legal: on, off]
 #Backlight=on
 
-# Set the disc mode [legal: 0=spin the "slim" disc - two disc segments,
-# 1=their complement spinning; default: 0]
+# Set the disc mode [legal: 0,1; default: 0]
+# 0 => spin the "slim" disc - two disc segments,
+# 1 => their complement spinning; 
 #DiscMode=0
 
 
@@ -859,7 +869,8 @@
 OffBrightness=50
 # set the serial port speed [default: 9600, legal: 1200, 2400, 9600, 19200, 115200]
 Speed=9600
-# Set serial data parity [default: 0 (None), legal: 0(=none), 1(=odd), 2(=even)]
+# Set serial data parity [default: 0; legal: 0-2 ]
+# Meaning: 0(=none), 1(=odd), 2(=even)
 Parity=0
 # re-initialize the VFD [default: no; legal: yes, no]
 Reboot=no
@@ -913,7 +924,8 @@
 LircPort=8765
 
 # Threshold in jiffies of synthesized gap that triggers flushing the IR data
-# to lirc [default: 100 (6.1ms); legal: 16 - 32767; 0 to disable].
+# to lirc [default: 100 ; max: 32767 ] 
+# 100 means 6.1ms. legal: 16 - 32767; Use 0 to disable.
 LircFlushThreshold=100
 
 
@@ -996,10 +1008,11 @@
 # (* most should work, not tested yet.)
 Type=0
 
-# "no" if display connected serial, "yes" if connected parallel. [default: no(=serial)]
+# "no" if display connected serial, "yes" if connected parallel. [default: no] 
+# I.e. serial by default
 use_parallel=no
 
-# Number of Custom-Characters [default: display type dependent]
+# Number of Custom-Characters. default is display type dependent
 #Custom-Characters=0
 
 # Portaddress where the LPT is. Used in parallel mode only. Usual values are 0x278, 0x378 and 0x3BC
@@ -1071,7 +1084,8 @@
 ## SVGAlib driver ##
 [svga]
 
-# svgalib mode to use [default: G320x240x256; legal: supported svgalib modes]
+# svgalib mode to use [default: G320x240x256 ]
+# legal values are supported svgalib modes
 #Mode=G640x480x256
 
 # set display size [default: 20x4]

series (text/plain, 29 B)

comments
fix-square-brackets

signature.asc (application/pgp-signature, 836 B)

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)

iQIcBAABAgAGBQJOpDmxAAoJEMMfT9lJqytsSqAQAI61yUf5rXpHpvyeNT5uKRPi
wWa6TcQsdrnSeH1EUG5jwyvhkjLfIBeVoL05ge9EUEStR0bHSQq2KxMFR9RPKHHx
XvL9CHdlNED3qaZuR31F/kuJPQNVZbeGXUM/wUtGWPPPhRAII5dB3HpKjl7KDpao
o/sR44j4kmqZbOsFPvgrqI9VSOXmmCnWcciVk1QlX8d2IWmyGUfDgRwEHZ88SeSq
ONuV6iDx50JoCCklQtzRUrkVaqCYew7zosAOilwOgg7jT8WmnTRbSflq0vRyB01C
+Rbm1ob6mSfBXZuxA/8yxaO1mu1xczbdn/1ft/ITDdpfRPpNQBSZaXWRx1GwB2i3
mCaZjrxFmqpguem2I+F4Epxzr2O/E7lTrNgCoV9Jsiz6e9TFU4W2476TVJ5BvWvI
HopWoPXnJG51SlgHcuVBYlYrd8xdu2woQwMSUWEoK3ehWjO2PQ+Zk2gnsj0hiBvu
ake1y9cVxUfZ7/+uYexAdSp4XA7xoTcs3wbXJyw/QJd/jzbTorCtv/uYL8j6HW8T
J1kDGhqWjZpRJOx+FodcSbU3uNf+eC2+hEit4fuJ74nAX8m+vX/SeC1Y3waMeDTL
HsdQjnVwmVWrrgig5DabN+fSnS65h3aGomh9l0wD+xkBnMDegkQCPNYOudqtVWfe
jUEkCSrB4MlHjwSsOI/Q
=P1TJ
-----END PGP SIGNATURE-----