linux/Documentation/DocBook
Georgi Chorbadzhiyski def6221604 [media] FE_READ_SNR and FE_READ_SIGNAL_STRENGTH docs
Around 01/14/2014 06:07 PM, Mauro Carvalho Chehab scribbled:
> Em Tue, 14 Jan 2014 17:55:19 +0200
> Georgi Chorbadzhiyski <gf@unixsol.org> escreveu:
>> Around 01/14/2014 05:30 PM, Mauro Carvalho Chehab scribbled:
>>> Em Tue, 14 Jan 2014 17:16:10 +0200
>>> Georgi Chorbadzhiyski <gf@unixsol.org> escreveu:
>>>
>>>> Hi guys, I'm confused the documentation on:
>>>>
>>>> http://linuxtv.org/downloads/v4l-dvb-apis/frontend_fcalls.html#FE_READ_SNR
>>>> http://linuxtv.org/downloads/v4l-dvb-apis/frontend_fcalls.html#FE_READ_SIGNAL_STRENGTH
>>>>
>>>> states that these ioctls return int16_t values but frontend.h states:
>>>>
>>>> https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/dvb/frontend.h
>>>>
>>>> #define FE_READ_SIGNAL_STRENGTH  _IOR('o', 71, __u16)
>>>> #define FE_READ_SNR              _IOR('o', 72, __u16)
>>>>
>>>> So which one is true?
>>>
>>> Documentation is wrong. The returned values are unsigned. Would you mind send
>>> us a patch fixing it?
>>
>> I would be happy to, but I can't find the repo that holds the documentation.
>
> It is in the Kernel tree, under Documentation/DocBook/media/dvb.

The attached file contains the discussed documentation fixes.

Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
2014-02-04 13:07:01 -02:00
..
media [media] FE_READ_SNR and FE_READ_SIGNAL_STRENGTH docs 2014-02-04 13:07:01 -02:00
.gitignore doc: Add "*.svg" to DocBook/.gitignore 2013-12-02 14:49:19 +01:00
80211.tmpl cfg80211: fix docbook references 2013-10-28 15:05:23 +01:00
alsa-driver-api.tmpl
debugobjects.tmpl debugobjects: Extend to assert that an object is initialized 2011-11-23 18:49:22 +01:00
device-drivers.tmpl doc: fix generation of device-drivers 2013-11-27 20:40:04 -08:00
deviceiobook.tmpl docbook: change iomap source filename in deviceiobook 2012-01-23 08:44:54 -08:00
drm.tmpl drm: implement experimental render nodes 2013-08-30 08:43:57 +10:00
filesystems.tmpl sysfs: merge regular and bin file handling 2013-10-05 17:27:40 -07:00
gadget.tmpl usb: gadget: Remove File-backed Storage Gadget (g_file_storage). 2012-11-08 16:01:04 +02:00
genericirq.tmpl irq: DocBook/genericirq.tmpl: Correct various typos 2013-10-19 10:25:17 +02:00
kernel-api.tmpl DocBook: include !Emm/util.c in kernel-api to include, kzfree and more 2013-12-02 14:42:57 +01:00
kernel-hacking.tmpl Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/trivial 2013-02-21 17:40:58 -08:00
kernel-locking.tmpl locking/doc: Update references to kernel/mutex.c 2013-11-11 12:41:33 +01:00
kgdb.tmpl Documentation: remove depends on CONFIG_EXPERIMENTAL 2013-01-11 11:38:03 -08:00
libata.tmpl Documentation: Fix typo in multiple files in Documentation 2012-04-16 14:37:13 +02:00
librs.tmpl
lsm.tmpl
Makefile DocBook: Make mandocs parallel-safe 2013-12-02 14:46:37 +01:00
media_api.tmpl [media] DocBook media: update copyright years and Introduction 2014-02-04 10:02:47 -02:00
mtdnand.tmpl mtd: nand_bbt: kill NAND_BBT_SCANALLPAGES 2013-11-06 23:33:14 -08:00
networking.tmpl docbook: networking: fix file paths for uapi headers 2012-10-15 08:04:41 -07:00
rapidio.tmpl docbook: fix rapidio warning 2011-03-27 19:30:19 -07:00
regulator.tmpl Fix common misspellings 2011-03-31 11:26:23 -03:00
s390-drivers.tmpl
scsi.tmpl
sh.tmpl sh: clkfwk: Kill off unused clk_set_rate_ex(). 2010-11-15 18:25:12 +09:00
stylesheet.xsl docbook: use IDs as filenames to support multiple books 2010-08-05 13:21:24 -07:00
tracepoint.tmpl workqueue: Add a workqueue chapter to the tracepoint docbook 2010-08-27 12:27:36 +02:00
uio-howto.tmpl uio-howto: example bug 2013-01-17 10:19:51 -08:00
usb.tmpl Fix common misspellings 2011-03-31 11:26:23 -03:00
writing_usb_driver.tmpl doc: fix misspellings with 'codespell' tool 2013-05-28 12:02:12 +02:00
writing-an-alsa-driver.tmpl ALSA: Make snd_BUG_ON() always evaluate and return the conditional expression 2013-03-11 09:33:34 +01:00
z8530book.tmpl