Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc updates for staging #5

Merged
merged 26 commits into from
Jan 9, 2012
Merged

Doc updates for staging #5

merged 26 commits into from
Jan 9, 2012

Conversation

marschap
Copy link
Contributor

@marschap marschap commented Sep 9, 2011

Hi,

please pull the doc-for-staging branch into opensc/staging.

It contains the following improvements:

  • fixed typos in various XML files
  • re-wording (= grammar corrections ;-)
  • harmonized tagging / design
  • alphabetlical order of options & commands
  • added missing information
  • no more templates, but correct paths (depending on the configure step)
    in man pages
  • better build system for man pages & HTML documentation
    • no need for kludges like e.g temporary directories
      (html.out, man.out, api.work)
    • 'make distcheck' clean (checked!)

These commits are part of the testing branch, which is used for Jenkings.
So you can check easily verify that the changes compile without problems.

Thanks for your support
Peter

@marschap
pkcs15-profile.xml: remove empty SYNOPSIS section
d824eb6
@marschap
piv-tool.xml: fix typo
bb9ffa1
@marschap
doc/tools/*.xml: use <refsynopsisdiv> sections
d25b30b 
Use <refsynopsisdiv> sections with <cmdsynopsis> tags for the synopsis
instead of plain <refsectX> sections. Create one where it was massing.
@marschap
doc/tools/*.xml: harmonize & complete <refmeta> sections
b628f14
@marschap
doc/tools/*.xml: use <citerefentry> in "See also" sections
4a3e977 
Instead of using plain text, use machine-parsable <citerefentry> sections
to refer to other odcuments.
@marschap
doc/tools/*.xml: add <refmiscinfo> class attributes
46389f5 
Use <refmiscinfo> with the class attributei values "productname","manual" and
"source".
This avoids some warnings when generating the manual pages.
@marschap
doc/Makefile.am: get rid of "api.work" kludge
0c7d1bd
@marschap
doc/tools/*.xml: include manpage sections in file names
aa5974b 
Rename source XML files so that their names contain the manpage sections.
@marschap
doc/tools/Makefile.am: new Makefile template for autotools
dbc5f75 
Created doc/tools/Makefile.am in order to generate a Makefile in doc/tools/.
Use pattern rules in doc/tools/Makefile.am; clean up doc/Makefile.am.
@marschap
doc/tools/Makefile.am: substitute @pkgdatadir@
d3b865e
@marschap
doc/tools/*.xml: more consistent formatting
a9c320f 
uUse specific tags:
<command> for commands
<option> for options
<replaceable> for values that need to be replaced with real values
@marschap
tools.xml: use 2 reference sections: tools & file formats
353067d 
Split the contents into two reference sections:
on for tools and one for file formats.
@marschap
opensc-explorer.1.xml: fix typos, more harmonization
1bff1c1
@marschap
piv-tool.1.xml: more harmonization, slight re-wording
77d051f
@marschap
pkcs15-crypt.1.xml: sort options alphabetically
d6a9cda
@marschap
opensc-explorer.1.xml: sort options & commands alphabetically
9f09113
@marschap
westcos-tool.1.xml: slight rewording
ca0343d
@marschap
cardos-tool.1.xml: sort options alphabetically
ea18c4a
@marschap
cryptoflex-tool.1.xml: sort options alphabetically
6227e07
@marschap
eidenv.1.xml: sort options alphabetically
55699b9
@marschap
netkey-tool.1.xml: sort options & commands alphabetically
1df0340
@marschap
opensc-tool.1.xml: sort options alphabetically
bd85c8f
@marschap
pkcs11-tool.1.xml: sort options alphabetically
6a6898a
@marschap
pkcs15-init.1.xml: sort options alphabetically, slight rewording
6b989ae
@marschap
pkcs15-tool.1.xml: sort options alphabetically
56a1ab6
@marschap
westcos-tool.1.xml: sort options alphabetically
3b6c985
LudovicRousseau added a commit that referenced this pull request Jan 9, 2012
@LudovicRousseau
Merge pull request #5 from marschap/doc-for-staging
3f7db42 
Doc updates for staging
@LudovicRousseau LudovicRousseau merged commit 3f7db42 into OpenSC:staging Jan 9, 2012
@berney berney mentioned this pull request Dec 1, 2014
Closed
@dengert dengert mentioned this pull request Feb 6, 2015
Closed
@dengert dengert mentioned this pull request Sep 9, 2015
Closed
@dengert dengert mentioned this pull request May 29, 2016
Closed
@dengert dengert mentioned this pull request Jul 6, 2016
Closed
@mor-anshuman mor-anshuman mentioned this pull request Dec 14, 2019
Closed
@dengert dengert mentioned this pull request Sep 2, 2020
Merged
3 tasks
xhanulik added a commit to xhanulik/OpenSC that referenced this pull request Jan 2, 2022
@xhanulik
pkcs15-libs.c: Free der value in ecparams
519b6c6 
Direct leak of 10 byte(s) in 1 object(s) allocated from:
    #0 0x519260 in realloc (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x519260)
    OpenSC#1 0x59ee3c in asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2022:16
    OpenSC#2 0x59eff2 in _sc_asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2050:9
    OpenSC#3 0x59f315 in sc_encode_oid /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2091:7
    OpenSC#4 0x5e0985 in sc_pkcs15_fix_ec_parameters /home/vhanulik/devel/OpenSC/src/libopensc/pkcs15-pubkey.c:1698:9
    OpenSC#5 0x56b9c7 in check_keygen_params_consistency /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:2369:8
    OpenSC#6 0x56a07a in sc_pkcs15init_generate_key /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:1468:6
    OpenSC#7 0x585394 in LLVMFuzzerTestOneInput /home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init.c:421:13
    OpenSC#8 0x45b2c0 in fuzzer::Fuzzer::ExecuteCallback(unsigned char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x45b2c0)
    OpenSC#9 0x43be53 in fuzzer::RunOneTest(fuzzer::Fuzzer*, char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x43be53)
    OpenSC#10 0x445481 in fuzzer::FuzzerDriver(int*, char***, int (*)(unsigned char const*, unsigned long)) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x445481)
    OpenSC#11 0x432d16 in main (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x432d16)
    OpenSC#12 0x7fc522555492 in __libc_start_main (/lib64/libc.so.6+0x23492)
xhanulik added a commit to xhanulik/OpenSC that referenced this pull request Jan 4, 2022
@xhanulik
pkcs15-libs.c: Free der value in ecparams
4c1e20e 
Direct leak of 10 byte(s) in 1 object(s) allocated from:
    #0 0x519260 in realloc (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x519260)
    OpenSC#1 0x59ee3c in asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2022:16
    OpenSC#2 0x59eff2 in _sc_asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2050:9
    OpenSC#3 0x59f315 in sc_encode_oid /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2091:7
    OpenSC#4 0x5e0985 in sc_pkcs15_fix_ec_parameters /home/vhanulik/devel/OpenSC/src/libopensc/pkcs15-pubkey.c:1698:9
    OpenSC#5 0x56b9c7 in check_keygen_params_consistency /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:2369:8
    OpenSC#6 0x56a07a in sc_pkcs15init_generate_key /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:1468:6
    OpenSC#7 0x585394 in LLVMFuzzerTestOneInput /home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init.c:421:13
    OpenSC#8 0x45b2c0 in fuzzer::Fuzzer::ExecuteCallback(unsigned char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x45b2c0)
    OpenSC#9 0x43be53 in fuzzer::RunOneTest(fuzzer::Fuzzer*, char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x43be53)
    OpenSC#10 0x445481 in fuzzer::FuzzerDriver(int*, char***, int (*)(unsigned char const*, unsigned long)) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x445481)
    OpenSC#11 0x432d16 in main (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x432d16)
    OpenSC#12 0x7fc522555492 in __libc_start_main (/lib64/libc.so.6+0x23492)
xhanulik added a commit to xhanulik/OpenSC that referenced this pull request Jan 4, 2022
@xhanulik
pkcs15-libs.c: Free der value in ecparams
4a1c7f5 
Direct leak of 10 byte(s) in 1 object(s) allocated from:
    #0 0x519260 in realloc (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x519260)
    OpenSC#1 0x59ee3c in asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2022:16
    OpenSC#2 0x59eff2 in _sc_asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2050:9
    OpenSC#3 0x59f315 in sc_encode_oid /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2091:7
    OpenSC#4 0x5e0985 in sc_pkcs15_fix_ec_parameters /home/vhanulik/devel/OpenSC/src/libopensc/pkcs15-pubkey.c:1698:9
    OpenSC#5 0x56b9c7 in check_keygen_params_consistency /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:2369:8
    OpenSC#6 0x56a07a in sc_pkcs15init_generate_key /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:1468:6
    OpenSC#7 0x585394 in LLVMFuzzerTestOneInput /home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init.c:421:13
    OpenSC#8 0x45b2c0 in fuzzer::Fuzzer::ExecuteCallback(unsigned char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x45b2c0)
    OpenSC#9 0x43be53 in fuzzer::RunOneTest(fuzzer::Fuzzer*, char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x43be53)
    OpenSC#10 0x445481 in fuzzer::FuzzerDriver(int*, char***, int (*)(unsigned char const*, unsigned long)) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x445481)
    OpenSC#11 0x432d16 in main (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x432d16)
    OpenSC#12 0x7fc522555492 in __libc_start_main (/lib64/libc.so.6+0x23492)
xhanulik added a commit to xhanulik/OpenSC that referenced this pull request Jan 9, 2022
@xhanulik
pkcs15-libs.c: Free der value in ecparams
409abb9 
Direct leak of 10 byte(s) in 1 object(s) allocated from:
    #0 0x519260 in realloc (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x519260)
    OpenSC#1 0x59ee3c in asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2022:16
    OpenSC#2 0x59eff2 in _sc_asn1_encode /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2050:9
    OpenSC#3 0x59f315 in sc_encode_oid /home/vhanulik/devel/OpenSC/src/libopensc/asn1.c:2091:7
    OpenSC#4 0x5e0985 in sc_pkcs15_fix_ec_parameters /home/vhanulik/devel/OpenSC/src/libopensc/pkcs15-pubkey.c:1698:9
    OpenSC#5 0x56b9c7 in check_keygen_params_consistency /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:2369:8
    OpenSC#6 0x56a07a in sc_pkcs15init_generate_key /home/vhanulik/devel/OpenSC/src/tests/fuzzing/../../../src/pkcs15init/pkcs15-lib.c:1468:6
    OpenSC#7 0x585394 in LLVMFuzzerTestOneInput /home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init.c:421:13
    OpenSC#8 0x45b2c0 in fuzzer::Fuzzer::ExecuteCallback(unsigned char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x45b2c0)
    OpenSC#9 0x43be53 in fuzzer::RunOneTest(fuzzer::Fuzzer*, char const*, unsigned long) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x43be53)
    OpenSC#10 0x445481 in fuzzer::FuzzerDriver(int*, char***, int (*)(unsigned char const*, unsigned long)) (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x445481)
    OpenSC#11 0x432d16 in main (/home/vhanulik/devel/OpenSC/src/tests/fuzzing/fuzz_pkcs15init+0x432d16)
    OpenSC#12 0x7fc522555492 in __libc_start_main (/lib64/libc.so.6+0x23492)
@MkfsSion MkfsSion mentioned this pull request May 25, 2022
Merged
1 task
@pc-bastler pc-bastler mentioned this pull request Dec 15, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@marschap @LudovicRousseau