mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Spell check Docbook guides. Hint: Installing a spell checker in you IDE is

Browse Source 
a good idea!
This commit is contained in:
mmdolze
2011-01-17 23:16:03 +00:00
parent e30ebae6a5
commit fc545022f8
27 changed files with 101 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-dev/add-your-driver.docbook
+6 -6
View File
@@ -65,7 +65,7 @@ driver to be included in LCDproc's code some conditions have to be met:</para>
</listitem>
<listitem>
<para>End user documentation (updates to man pages <emphasis>AND</emphasis>
User's Guide in docbook format) is available.</para>
User's Guide in Docbook format) is available.</para>
</listitem>
<listitem>
<para>Driver options are described in the end user documentation
@@ -90,7 +90,7 @@ automake. This allows LCDproc to be ported to several platforms with much
less effort. It can be quite daunting to understand how autoconf &amp;
automake interact with each others and with your code, but don't be
discouraged. We have taken great care in making this as simple as possible
for programers to add their own driver to LCDproc. Hopefully, you'll only
for programmers to add their own driver to LCDproc. Hopefully, you'll only
have to modify two files, one for autoconf and one for automake.
</para>
@@ -191,7 +191,7 @@ mailing list and we'll make it for you.
<sect2 id="automake">
<title>Automake and its friend, Makefile.am</title>
<para>Allready half of the job is done! Not to bad, wasn't it? The rest
<para>Already half of the job is done! Not to bad, wasn't it? The rest
should be just as easy. In this section, you'll be adding your driver to the
file server/drivers/Makefile.am. As you can guess, it's the Makefile for the
drivers. This can be done in three (or two) simple steps.</para>
@@ -219,7 +219,7 @@ EXTRA_PROGRAMS = bayrad CFontz ...(big list)... ula200 xosd <emphasis>myDriver</
<para>This second step is only needed if your driver needs a particular
library. If it doesn't, you can skip to step 3.</para>
<para>You basically need to put you driver name followed by _LDADD and egal
<para>You basically need to put you driver name followed by _LDADD and equal
this to the name of the library that you need. Usually, these library are
substituted by a autoconf variable, if you're not comfortable with this, you
send an email to the mailing list and we'll set this up for you.</para>
@@ -237,7 +237,7 @@ myDriver_LDADD = @SOMESTRANGELIB@
<para>
Last but not least, you need to specify which source files should be
associated with your driver. You put your driver name followed by
<literal>_SOURCES</literal> and egal this to a space separated list
<literal>_SOURCES</literal> and equal this to a space separated list
of the source and header files. See below for an example.</para>
<screen>
@@ -385,7 +385,7 @@ to the directory <filename>docs/lcdproc-user/drivers/</filename>.
<title>Step 2</title>
<para>
Define a Docbook entity for your driverfile in <filename>lcdproc-user.docbook</filename>.
Define a Docbook entity for your driver file in <filename>lcdproc-user.docbook</filename>.
</para>
<screen>
docs/lcdproc-dev/driver-api.docbook
+5 -5
View File
@@ -34,7 +34,7 @@
</itemizedlist>
<para>
The API is best descibed by starting with the struct lcd_logical_driver
The API is best described by starting with the struct lcd_logical_driver
which is defined in server/drivers/lcd.h.
</para>
@@ -209,9 +209,9 @@ typedef struct lcd_logical_driver {
<title>Private Data</title>
<para>
With the introduction of loadable modules it is necesary to stop using global
With the introduction of loadable modules it is necessary to stop using global
variables to store a driver's data in. Instead, you should store it in a
structure, that you allocate abd store on driver's init. If you don't use
structure, that you allocate and store on driver's init. If you don't use
this system, but use globals, you get queer results if you run two LCDd
daemons on one machine. They will then use the same variables !
</para>
@@ -599,7 +599,7 @@ typedef struct MyDriver_private_data {
</funcsynopsis>
<para>
Checks if a key has been pressed on the device.
Returns NULL for "no key pressed", or a string describing the pressd key.
Returns NULL for "no key pressed", or a string describing the pressed key.
These characters should match the keypad-layout.
</para>
@@ -682,7 +682,7 @@ typedef struct MyDriver_private_data {
</funcprototype>
</funcsynopsis>
<para>
Returns wether a section exists. Does not need to be called prior
Returns whether a section exists. Does not need to be called prior
to a call to a config_get_* function.
</para>
docs/lcdproc-dev/language.docbook
+8 -8
View File
@@ -12,7 +12,7 @@
<para>
The LCDproc clients, for example lcdproc, connect over the network to
LCDd. In their communication they use a protocol, often refered to as
LCDd. In their communication they use a protocol, often referred to as
the "widget language". In this chapter the widget language will be
discussed.
</para>
@@ -218,7 +218,7 @@
<para>
Sets attributes for the given screen. The following attributes
exist:
<variablelist><!--<title>screen_set attributes</title>-->
<variablelist>
<varlistentry>
<term>
<option>-name <replaceable>name</replaceable></option>
@@ -338,7 +338,7 @@
</term>
<listitem><para>
Changes the screen's backlight setting.
If iset to the default value <literal>open</literal>,
If set to the default value <literal>open</literal>,
the state will be determined by the client's setting.
<literal>blink</literal> is a moderately striking backlight variation,
<literal>flash</literal> is <emphasis>very</emphasis> strinking.
@@ -512,7 +512,7 @@
<para>
Sets parameters for a widget. Because not all widgets are created equal,
the various widget types require different parameters.
<variablelist><!--<title>widget_set required parameters per widget type</title>-->
<variablelist>
<varlistentry>
<term>
<literal>string</literal>
@@ -838,8 +838,8 @@
<literal>ip</literal>
</term>
<listitem><para>
Allows the user to input an ip number (v4 or
v6). When selected, a screen comes up that shows an ip
Allows the user to input an IP number (v4 or
v6). When selected, a screen comes up that shows an IP
number that can be edited - digit by digit - via
left/right (switch digit) and up/down keys
(increase/decrease).
@@ -1447,7 +1447,7 @@
<computeroutput>success</computeroutput>
</term>
<listitem><para>
This is the reponse to a command in case everything went ok.
This is the response to a command in case everything went OK.
</para></listitem>
</varlistentry>
<varlistentry>
@@ -1544,7 +1544,7 @@
<literal>leave</literal>
</term>
<listitem><para>
This item has been left, so it is currenly not the (main)
This item has been left, so it is currently not the (main)
active item anymore.
</para></listitem>
</varlistentry>
docs/lcdproc-dev/make-driver.docbook
+12 -12
View File
@@ -3,11 +3,11 @@
<para>
Driving an LCD display is not easy; you need to address ports, to send bytes
in a certain order, to respect timing, and unfortunaly no two operating system
let you do this in the same way. But don't dispair! There's hope! Someone in
a galaxy far far away, has allready done the dirty job for you! This dirty job
in a certain order, to respect timing, and unfortunately no two operating system
let you do this in the same way. But don't despair! There's hope! Someone in
a galaxy far far away, has Already done the dirty job for you! This dirty job
has been put in shared files. These shared files are full cross platform and
are automagically configured by the configure script. You only need to include
are auto-magically configured by the configure script. You only need to include
them and use their functions to benefit from them.
</para>
@@ -196,7 +196,7 @@ port_deny_multiple(0x378, 3);
<term><function>get_free_chars()</function></term>
<listitem>
<para>
to determine the number of user-defineable characters that can be
to determine the number of user-definable characters that can be
used in the generation of big numbers.
</para>
</listitem>
@@ -207,7 +207,7 @@ port_deny_multiple(0x378, 3);
<listitem>
<para>
to define a character necessary to write a big number.
Of course this is only necessary if there really are user-definieable
Of course this is only necessary if there really are user-definable
characters, i.e. only if <function>get_free_chars()</function> returns
a value greater <literal>0</literal>.
</para>
@@ -285,7 +285,7 @@ port_deny_multiple(0x378, 3);
<term><parameter>drvthis</parameter></term>
<listitem>
<para>
the pointer pointing to the Driver structure passed to thea driver's
the pointer pointing to the Driver structure passed to the driver's
<function>num()</function> function.
</para>
</listitem>
@@ -317,9 +317,9 @@ port_deny_multiple(0x378, 3);
<term><parameter>offset</parameter></term>
<listitem>
<para>
the character position where the user-defineable characters start
the character position where the user-definable characters start
(usually <literal>0</literal>).
The user-defineable characters (if any) are then expected to be at the character positions
The user-definable characters (if any) are then expected to be at the character positions
<replaceable>offset</replaceable><literal>+0</literal>,
<replaceable>offset</replaceable><literal>+1</literal>,
<replaceable>offset</replaceable><literal>+2</literal>, ...
@@ -408,7 +408,7 @@ myDriver_SOURCES: lcd.h lcd_lib.h myDriver.c myDriver.h report.h <emphasis>adv_b
The display-dependent functions are named
<function>adv_bignum_num_<replaceable>N_M</replaceable>()</function>,
where <replaceable>N</replaceable> is the display's height in lines and <replaceable>M</replaceable>
the number of used user-defineable characters.
the number of used user-definable characters.
The bits of the user-characters are stored in <replaceable>static char bignum</replaceable>
(take a look at the source and you will see what I mean). (On a display with a
<replaceable>cellheight</replaceable> of 7 the lowest line stored is not shown.)
@@ -418,8 +418,8 @@ myDriver_SOURCES: lcd.h lcd_lib.h myDriver.c myDriver.h report.h <emphasis>adv_b
</para>
<para>
If user-defineable characters have to be set, the driver's <function>set_char()</function> function
will be called once for every user-idefneable character.
If user-definable characters have to be set, the driver's <function>set_char()</function> function
will be called once for every user-definable character.
</para>
<para>
docs/lcdproc-dev/programming.docbook
+8 -8
View File
@@ -9,7 +9,7 @@ the most current source code available. You can get it several ways:</para>
<orderedlist>
<listitem>
<para>Download yesterday's CVS version of as a tarball (prefered).</para>
<para>Download yesterday's CVS version of as a tarball (preferred).</para>
</listitem>
<listitem>
<para>Download the latest version from CVS.</para>
@@ -100,7 +100,7 @@ different programming styles (naming, indention, etc) in the source code.
</para>
<para>
When modifying an existing file, please take a careful look at its style and
program continueing that style instead of mixing it up with another one even
program continuing that style instead of mixing it up with another one even
if it does not comply with the guidelines written below.
</para>
<para>
@@ -121,7 +121,7 @@ should look like.
<para>
<emphasis>Language: </emphasis>The programming language used for LCDd
(server core), drivers and the lcdproc client is <literal>C</literal>.
No other programming lanuage will be accepted.
No other programming language will be accepted.
</para>
</listitem>
<listitem>
@@ -168,7 +168,7 @@ should look like.
<para>
<emphasis>Variable names:</emphasis>
We do not use Hungarian Notation. CamelCase may be used,
but names shall beginn with a lowercase letter.
but names shall begin with a lowercase letter.
</para>
</listitem>
<listitem>
@@ -256,7 +256,7 @@ unsigned char HD44780_scankeypad(PrivateData *p);
<para><emphasis>Function declarations:</emphasis></para>
<para>
Function declarations have their declaration and
opening brace split accross two lines.
opening brace split across two lines.
</para>
<para>
Function names start in column one. The return type is placed on the
@@ -333,7 +333,7 @@ lib_vbar_static(drvthis, x, y, len, promille, options, p->cellheight, 0);
is there is a previous closing brace.
</para>
<para>
Opening and closing braces may be ommited on single line compound
Opening and closing braces may be omitted on single line compound
statements. However, if one part of an if-else-statement requires braces
the other part shall have braces as well.
</para>
@@ -401,7 +401,7 @@ the LCDproc project. You usually do this by submitting a patch for review to the
mailing list.</para>
<para>To create a patch you need the unmodified files and the files containing
your modificatiosn. Usually you do this by storing an unmodified copy of the
your modifications. Usually you do this by storing an unmodified copy of the
sources in one directory and another copy with your modifications in another
one. You then run <command>diff</command> like this:</para>
@@ -427,7 +427,7 @@ you can also run <command>cvs diff</command> from the working directory:</para>
<note>
<para>Some versions of <command>cvs diff</command> will not handle new files
because these are unkown to the repository. There are ways to make cvs believe
because these are unknown to the repository. There are ways to make cvs believe
the files existed previously (fake add) but this is not recommended. You will
need to submit new files 'as-is' in this case.</para>
</note>
docs/lcdproc-dev/releasing.docbook
+4 -4
View File
@@ -90,7 +90,7 @@ release.
<step>
<para>
Tag the stable tree to indicate the file revision where the branch was
made. This eases later diffs againt that point.
made. This eases later diffs against that point.
</para>
<para>
Run: <userinput>cvs tag LCDPROC_0_5_<replaceable>A</replaceable>_BP</userinput>
@@ -107,14 +107,14 @@ release.
<userinput>cvs tag -b lcdproc-0-5-<replaceable>A</replaceable></userinput>
</para>
<note>
<para>Release branch names are all lowercase with hypens to separate
<para>Release branch names are all lowercase with hyphens to separate
elements!</para>
</note>
</step>
<step>
<para>
Now you have created a branch from which the new release will done. Before
continuing either checkout this new branch to a new workding directory
continuing either checkout this new branch to a new working directory
or update the current one by running:
<userinput>cvs update -r lcdproc-0-5-<replaceable>A</replaceable></userinput>
</para>
@@ -267,7 +267,7 @@ Here is how to create these documentation packages.
</procedure>
<para>
The online documenation consists of the user and developer guide, each
The online documentation consists of the user and developer guide, each
converted to a single file for viewing online.
</para>
docs/lcdproc-dev/shared-files.docbook
+1 -1
View File
@@ -32,7 +32,7 @@ Here we provide functions that should be used by all parts of the program.
<para>
This way, the global DEBUG macro is off but is locally enabled in
certains parts of the software.</para>
certain parts of the software.</para>
<para>The reporting levels have the following meaning.</para>