aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/staging/comedi
diff options
context:
space:
mode:
authorIan Abbott <abbotti@mev.co.uk>2010-06-14 07:49:26 -0400
committerGreg Kroah-Hartman <gregkh@suse.de>2010-06-17 19:03:58 -0400
commit9a390f38b6a84d5a11c89a116363db3fe587598b (patch)
tree6167de348a1b3808e0f5c8c5c6a774fe635425fb /drivers/staging/comedi
parent389cd417e3b0f707ecd933b8fd26e910898ac2fc (diff)
Staging: comedi: drivers: skel: Add whitespace to example comment block
The Comedi team have a script 'dump_doc' to extract text from the driver comment block (starting with line 'Driver:') in (most of) the comedi driver source files. This was recently updated to allow and strip off a " * " prefix at the start of each line (well actually, it uses the perl substitution 's/^ ?\* ?//'). The skel.c file contains an instructional comment block about how to format this driver comment block, but the updated 'dump_doc' script mistakenly treats this as a valid driver comment block. This patch adds some extra whitespace to stop the instructional comment block being treated as a valid driver comment block by Comedi's 'dump_doc' script. Signed-off-by: Ian Abbott <abbotti@mev.co.uk> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'drivers/staging/comedi')
-rw-r--r--drivers/staging/comedi/drivers/skel.c44
1 files changed, 22 insertions, 22 deletions
diff --git a/drivers/staging/comedi/drivers/skel.c b/drivers/staging/comedi/drivers/skel.c
index 732a323ab71..0b9ecb19511 100644
--- a/drivers/staging/comedi/drivers/skel.c
+++ b/drivers/staging/comedi/drivers/skel.c
@@ -39,28 +39,28 @@ Configuration Options:
39 * The previous block comment is used to automatically generate 39 * The previous block comment is used to automatically generate
40 * documentation in Comedi and Comedilib. The fields: 40 * documentation in Comedi and Comedilib. The fields:
41 * 41 *
42 * Driver: the name of the driver 42 * Driver: the name of the driver
43 * Description: a short phrase describing the driver. Don't list boards. 43 * Description: a short phrase describing the driver. Don't list boards.
44 * Devices: a full list of the boards that attempt to be supported by 44 * Devices: a full list of the boards that attempt to be supported by
45 * the driver. Format is "(manufacturer) board name [comedi name]", 45 * the driver. Format is "(manufacturer) board name [comedi name]",
46 * where comedi_name is the name that is used to configure the board. 46 * where comedi_name is the name that is used to configure the board.
47 * See the comment near board_name: in the struct comedi_driver structure 47 * See the comment near board_name: in the struct comedi_driver structure
48 * below. If (manufacturer) or [comedi name] is missing, the previous 48 * below. If (manufacturer) or [comedi name] is missing, the previous
49 * value is used. 49 * value is used.
50 * Author: you 50 * Author: you
51 * Updated: date when the _documentation_ was last updated. Use 'date -R' 51 * Updated: date when the _documentation_ was last updated. Use 'date -R'
52 * to get a value for this. 52 * to get a value for this.
53 * Status: a one-word description of the status. Valid values are: 53 * Status: a one-word description of the status. Valid values are:
54 * works - driver works correctly on most boards supported, and 54 * works - driver works correctly on most boards supported, and
55 * passes comedi_test. 55 * passes comedi_test.
56 * unknown - unknown. Usually put there by ds. 56 * unknown - unknown. Usually put there by ds.
57 * experimental - may not work in any particular release. Author 57 * experimental - may not work in any particular release. Author
58 * probably wants assistance testing it. 58 * probably wants assistance testing it.
59 * bitrotten - driver has not been update in a long time, probably 59 * bitrotten - driver has not been update in a long time, probably
60 * doesn't work, and probably is missing support for significant 60 * doesn't work, and probably is missing support for significant
61 * Comedi interface features. 61 * Comedi interface features.
62 * untested - author probably wrote it "blind", and is believed to 62 * untested - author probably wrote it "blind", and is believed to
63 * work, but no confirmation. 63 * work, but no confirmation.
64 * 64 *
65 * These headers should be followed by a blank line, and any comments 65 * These headers should be followed by a blank line, and any comments
66 * you wish to say about the driver. The comment area is the place 66 * you wish to say about the driver. The comment area is the place