* [lm-sensors] [PATCH] i2c-tools / man pages for decode-dimms & decode-vaio
@ 2013-10-04 10:15 Jaromir Capik
2013-10-05 10:07 ` Jean Delvare
0 siblings, 1 reply; 2+ messages in thread
From: Jaromir Capik @ 2013-10-04 10:15 UTC (permalink / raw)
To: lm-sensors
[-- Attachment #1: Type: text/plain, Size: 386 bytes --]
Hello.
The attached patch introduces man pages for
the decode-dimms and the decode-vaio tool.
Please, check, modify if needed and merge.
Thanks in advance.
Regards,
Jaromir.
--
Jaromir Capik
Red Hat Czech, s.r.o.
Software Engineer / Secondary Arch
Email: jcapik@redhat.com
Web: www.cz.redhat.com
Red Hat Czech s.r.o., Purkynova 99/71, 612 45, Brno, Czech Republic
IC: 27690016
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: i2c-tools-3.1-man-decodeX.patch --]
[-- Type: text/x-patch; name=i2c-tools-3.1-man-decodeX.patch, Size: 5286 bytes --]
diff -Naur i2c-tools-3.1.0.orig/eeprom/decode-dimms.1 i2c-tools-3.1.0/eeprom/decode-dimms.1
--- i2c-tools-3.1.0.orig/eeprom/decode-dimms.1 1970-01-01 01:00:00.000000000 +0100
+++ i2c-tools-3.1.0/eeprom/decode-dimms.1 2013-10-03 18:01:35.396288464 +0200
@@ -0,0 +1,77 @@
+.\"
+.\" decode-dimms.1 - manpage for the i2c-tools/decode-dimms utility
+.\" Copyright (C) 2013 Jaromir Capik
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+.\"
+.TH decode-dimms 1 "Oct 2013" "i2c-tools" "User Commands"
+.SH NAME
+decode-dimms \- Decode the information found in memory module SPD EEPROMs.
+.SH SYNOPSIS
+.B decode-dimms
+[-c] [-f [-b]] [-x|-X file [files..]]
+.br
+.B decode-dimms
+-h
+.SH DESCRIPTION
+
+The purpose of the
+.B decode-dimms
+tool is to decode the information found in memory module SPD EEPROMs.
+The SPD data is read either from the running system or dump files.
+The tool requires the eeprom kernel module to be loaded.
+.SH PARAMETERS
+.TP
+.B \-f, --format
+Print nice html output
+.TP
+.B \-b, --bodyonly
+Don't print html header (useful for postprocessing the output)
+.TP
+.B \--side-by-side
+Display all DIMMs side-by-side if possible
+.TP
+.B \--merge-cells
+Merge neighbour cells with identical values (side-by-side output only)
+.TP
+.B \-c, --checksum
+Decode completely even if checksum fails
+.TP
+.B \-x
+Read data from hexdump files
+.TP
+.B \-X
+Same as -x except treat multibyte hex data as little endian
+.TP
+.B \-h, --help
+Display this usage summary
+.SH SEE ALSO
+.BR decode-vaio (1)
+.SH AUTHORS
+.UR phil@netroedge.com
+Philip Edelbrock
+.UE
+.br
+.UR zany@triq.net
+Christian Zuckschwerdt
+.UE
+.br
+.UR burkart@bollchen.de
+Burkart Lingner
+.UE
+.br
+.UR khali@linux-fr.org
+Jean Delvare
+.UE
diff -Naur i2c-tools-3.1.0.orig/eeprom/decode-vaio.1 i2c-tools-3.1.0/eeprom/decode-vaio.1
--- i2c-tools-3.1.0.orig/eeprom/decode-vaio.1 1970-01-01 01:00:00.000000000 +0100
+++ i2c-tools-3.1.0/eeprom/decode-vaio.1 2013-10-03 18:02:49.348720736 +0200
@@ -0,0 +1,37 @@
+.\"
+.\" decode-vaio.1 - manpage for the i2c-tools/decode-vaio utility
+.\" Copyright (C) 2013 Jaromir Capik
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+.\"
+.TH decode-vaio 1 "Oct 2013" "i2c-tools" "User Commands"
+.SH NAME
+decode-vaio \- Decode the information found in the Sony Vaio laptop
+identification EEPROMs.
+.SH SYNOPSIS
+.B decode-vaio
+.SH DESCRIPTION
+
+The purpose of the
+.B decode-vaio
+tool is to decode the information found in the Sony Vaio laptop
+identification EEPROMs.
+The tool requires the eeprom kernel module to be loaded.
+.SH SEE ALSO
+.BR decode-dimms (1)
+.SH AUTHOR
+.UR khali@linux-fr.org
+Jean Delvare
+.UE
diff -Naur i2c-tools-3.1.0.orig/eeprom/Module.mk i2c-tools-3.1.0/eeprom/Module.mk
--- i2c-tools-3.1.0.orig/eeprom/Module.mk 2009-01-13 18:32:03.000000000 +0100
+++ i2c-tools-3.1.0/eeprom/Module.mk 2013-10-04 11:58:45.000000000 +0200
@@ -7,9 +7,10 @@
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
-EEPROM_DIR := eeprom
+EEPROM_DIR := eeprom
-EEPROM_TARGETS := decode-dimms decode-vaio ddcmon decode-edid
+EEPROM_TARGETS := decode-dimms decode-vaio ddcmon decode-edid
+EEPROM_MAN_TARGETS := decode-dimms.1 decode-vaio.1
#
# Commands
@@ -24,6 +25,16 @@
for program in $(EEPROM_TARGETS) ; do \
$(RM) $(DESTDIR)$(bindir)/$$program ; done
-install: install-eeprom
+install-eeprom-man: $(addprefix $(EEPROM_DIR)/,$(EEPROM_MAN_TARGETS))
+ $(INSTALL_DIR) $(DESTDIR)$(mandir)/man1
+ for manual in $(EEPROM_MAN_TARGETS) ; do \
+ $(INSTALL_DATA) $(EEPROM_DIR)/$$manual $(DESTDIR)$(mandir)/man1 ; done
-uninstall: uninstall-eeprom
+uninstall-eeprom-man:
+ for manual in $(EEPROM_MAN_TARGETS) ; do \
+ $(RM) $(DESTDIR)$(mandir)/$$manual ; done
+
+
+install: install-eeprom install-eeprom-man
+
+uninstall: uninstall-eeprom uninstall-eeprom-man
[-- Attachment #3: Type: text/plain, Size: 153 bytes --]
_______________________________________________
lm-sensors mailing list
lm-sensors@lm-sensors.org
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [lm-sensors] [PATCH] i2c-tools / man pages for decode-dimms & decode-vaio
2013-10-04 10:15 [lm-sensors] [PATCH] i2c-tools / man pages for decode-dimms & decode-vaio Jaromir Capik
@ 2013-10-05 10:07 ` Jean Delvare
0 siblings, 0 replies; 2+ messages in thread
From: Jean Delvare @ 2013-10-05 10:07 UTC (permalink / raw)
To: lm-sensors
Hi Jaromir,
On Fri, 4 Oct 2013 06:15:20 -0400 (EDT), Jaromir Capik wrote:
> The attached patch introduces man pages for
> the decode-dimms and the decode-vaio tool.
Thanks for your contribution.
> Please, check, modify if needed and merge.
Applied [1], with the following changes:
* Added the new option --no-merge-cells to decode-dimms.1
* Removed e-mail addresses, they quickly become out-of-date and
contacting the original code author is generally not the right thing
to do for a end user.
* Simplified Makefile integration. If manual pages are ever written for
ddcmon and decode-edid, the code can be simplified even further.
[1] http://www.lm-sensors.org/changeset/6200
Thanks again,
--
Jean Delvare
_______________________________________________
lm-sensors mailing list
lm-sensors@lm-sensors.org
http://lists.lm-sensors.org/mailman/listinfo/lm-sensors
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2013-10-05 10:07 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-10-04 10:15 [lm-sensors] [PATCH] i2c-tools / man pages for decode-dimms & decode-vaio Jaromir Capik
2013-10-05 10:07 ` Jean Delvare
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.