[yosys] 01/01: Added information in man pages

[Ruben Undheim]

This is an automated email from the git hooks/post-receive script.

rubund-guest pushed a commit to branch master
in repository yosys.

commit a27b89f2bd3334075a07c12e8ad7635021b96638
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Thu Oct 16 19:03:11 2014 +0200

    Added information in man pages
---
 debian/yosys-config.1    | 22 ++++++++++++++++------
 debian/yosys-filterlib.1 | 15 ++++++++++-----
 debian/yosys.1           |  2 ++
 3 files changed, 28 insertions(+), 11 deletions(-)

diff --git a/debian/yosys-config.1 b/debian/yosys-config.1
index c1f89a4..f8d45b1 100644
--- a/debian/yosys-config.1
+++ b/debian/yosys-config.1
@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH YOSYS-CONFIG 1 "September 13, 2014"
+.TH YOSYS-CONFIG 1 "October 16, 2014"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -29,15 +29,25 @@ command.
 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
 .\" respectively.
-\fByosys-config\fP is a utility delivered together with yosys.
+\fByosys-config\fP is a shell script which can be used to query compiler options and other information needed for building loadable modules for yosys. It is similar in behaviour to pkg-config.
 .SH OPTIONS
 A summary of options is included below.
-.\"#.TP
-.\"a
+.TP
+.B \-\-cxx
+.TP
+.B \-\-cxxflag
+.TP
+.B \-\-ldflags
+.TP
+.B \-\-ldlibs
+.TP
+.B \-\-bindir
+.TP
+.B \-\-datdir
 .SH SEE ALSO
-yosys(1), yosys-filterlib(1) 
+yosys(1), yosys-filterlib(1)
 .SH AUTHOR
-yosys was written by Clifford Wolf <clifford at clifford.at>.
+yosys-config was written by Clifford Wolf <clifford at clifford.at>.
 .PP
 This manual page was written by Ruben Undheim <ruben.undheim at gmail.com>,
 for the Debian project (and may be used by others).
diff --git a/debian/yosys-filterlib.1 b/debian/yosys-filterlib.1
index 41b9d7c..457159e 100644
--- a/debian/yosys-filterlib.1
+++ b/debian/yosys-filterlib.1
@@ -2,7 +2,7 @@
 .\" First parameter, NAME, should be all caps
 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
 .\" other parameters are allowed: see man(7), man(1)
-.TH YOSYS-FILTERLIB 1 "September 13, 2014"
+.TH YOSYS-FILTERLIB 1 "October 16, 2014"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -29,15 +29,20 @@ command.
 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
 .\" respectively.
-\fByosys-filterlib\fP is a utility delivered together with yosys.
-.SH OPTIONS
-A summary of options is included below.
+\fByosys-filterlib\fP is a program used to strip sensitive information from Liberty files.
+
+Occasionally Liberty files contain trade secrets (such as sensitive timing information) that cannot be shared
+freely. This complicates processes such as reporting bugs in the tools involved. When the information in
+the Liberty file used by Yosys and ABC are not part of the sensitive information, this tool
+yosys-filterlib can be used to strip the sensitive information from the Liberty file.
+.\".SH OPTIONS
+.\"A summary of options is included below.
 .\"#.TP
 .\"a
 .SH SEE ALSO
 yosys(1), yosys-config(1) 
 .SH AUTHOR
-yosys was written by Clifford Wolf <clifford at clifford.at>.
+yosys-filterlib was written by Clifford Wolf <clifford at clifford.at>.
 .PP
 This manual page was written by Ruben Undheim <ruben.undheim at gmail.com>,
 for the Debian project (and may be used by others).
diff --git a/debian/yosys.1 b/debian/yosys.1
index 2f78cd8..13c93bc 100644
--- a/debian/yosys.1
+++ b/debian/yosys.1
@@ -77,6 +77,8 @@ The option \-S is an alias for the following options that perform a simple
 transformation of the input to a gate-level netlist.
 
     \-p hierarchy \-p proc \-p opt \-p memory \-p opt \-p techmap \-p opt
+.SH SEE ALSO
+berkeley-abc(1), yosys-config(1), yosys-filterlib(1)
 .SH AUTHOR
 yosys was written by Clifford Wolf <clifford at clifford.at>.
 .PP

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/yosys.git