Em Fri, 28 Oct 2016 08:49:12 -0400
Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx> escreveu:
> On Fri, Oct 28, 2016 at 08:31:57AM -0400, Greg Kroah-Hartman wrote:
> > On Fri, Oct 28, 2016 at 10:19:47AM -0200, Mauro Carvalho Chehab wrote:
> > > Use a script to parse the Documenation/ABI directory and output
> > > it at the admin-guide.
> > >
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> > > ---
> > > Documentation/admin-guide/abi.rst | 5 +
> > > Documentation/admin-guide/index.rst | 1 +
> > > Documentation/sphinx/abi_book.pl | 208 ++++++++++++++++++++++++++++++++++++
> > > 3 files changed, 214 insertions(+)
> > > create mode 100644 Documentation/admin-guide/abi.rst
> > > create mode 100755 Documentation/sphinx/abi_book.pl
> >
> > Any hint as to what the output of this actually looks like?
>
> Doh, you already showed it in patch 0/3, that's what I get for never
> reading cover letters...
:-)
> sorry for the noise,
No problem.
Btw, looking at the output of the script, I noticed a
few files where "What" doesn't point to configfs/sysfs/procfs:
- Documentation/ABI/testing/sysfs-class-rtc-rtc0-device-rtc_calibration
What: Attribute for calibrating ST-Ericsson AB8500 Real Time Clock
This is probably a sysfs interface, so, IMHO, "What" here is wrong.
>From the name of the file, I suspect that it should be, instead:
What: /sysfs/class/rtc/rtc0/device/rtc_calibration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Documentation/ABI/stable/thermal-notification
What: A notification mechanism for thermal related events
Not sure what kind of interface this is referring to. Perhaps a
sysctl interface?
- Documentation/ABI/stable/syscalls
What: The kernel syscall interface
This sounds OK, although it probably makes sense to document
each system call.
- Documentation/ABI/testing/sysfs-devices-system-ibm-rtl
What: state
What: version
According with their descriptions, both are needed for the
"ibm-prtm" userspace daemon, but it provides no glue where
this should be located. Looking at its source file, it seems
that they should be located at [1]:
/sys/devices/system/ibm_rtl/state
and
/proc/version
Btw, IMHO, it doesn't make much sense to document /proc/version
inside sysfs-devices-system-ibm-rtl.
-
There are a few other such cases at ABI/removed, but I guess it is
safe to ignore those ;)
Thanks,
Mauro
[1] looking at the ibm-prtm, this is what I got:
$ ack state
ibm-prtmd
127: if not os.path.exists("/sys/devices/system/ibm_rtl/state"):
130: # check IBM RTL state is enabled
131: return bool(int(open("/sys/devices/system/ibm_rtl/state").read()))
357: if os.path.exists("/sys/devices/system/ibm_rtl/state"):
ibm-prtm
62: if ! echo 1 > /sys/devices/system/ibm_rtl/state; then
76: echo 0 > /sys/devices/system/ibm_rtl/state
89: #$prog failed to start undo state
90: echo 0 > /sys/devices/system/ibm_rtl/state
105: echo 0 > /sys/devices/system/ibm_rtl/state
mchehab@vento ~/Downloads/a/ibm-prtm-1.10 $ ack version
ibm-prtmd
10:# as published by the Free Software Foundation; either version 2
11:# of the License, or (at your option) any later version.
430: if "2.6.22" in open("/proc/version").read():
444: if "2.6.22" in open("/proc/version").read():
585: print " --version print version number"
616: elif arg == "--version":
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
