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.

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

Update Documentation for config and input engine #857

Merged
merged 14 commits into from Aug 12, 2020

Conversation

Niraj-Kamdar
Copy link
Contributor

@Niraj-Kamdar Niraj-Kamdar commented Jul 31, 2020

  • update manual
  • update readme
  • update csv2cve

Depends on #846
Fixes: #806

update manual
update
update image
update
@codecov-commenter
Copy link

codecov-commenter commented Jul 31, 2020

Codecov Report

Merging #857 into master will decrease coverage by 2.25%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #857      +/-   ##
==========================================
- Coverage   87.85%   85.60%   -2.26%     
==========================================
  Files         164      164              
  Lines        2710     2710              
  Branches      295      295              
==========================================
- Hits         2381     2320      -61     
- Misses        258      311      +53     
- Partials       71       79       +8     
Flag Coverage Δ
#longtests 85.60% <ø> (-2.26%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
cve_bin_tool/checkers/xml2.py 61.36% <0.00%> (-27.28%) ⬇️
test/test_json.py 68.96% <0.00%> (-20.69%) ⬇️
test/test_cli.py 80.45% <0.00%> (-18.05%) ⬇️
test/test_scanner.py 80.00% <0.00%> (-10.59%) ⬇️
cve_bin_tool/cli.py 83.72% <0.00%> (-3.11%) ⬇️
cve_bin_tool/version_scanner.py 84.34% <0.00%> (-1.74%) ⬇️
cve_bin_tool/extractor.py 59.05% <0.00%> (-1.58%) ⬇️
cve_bin_tool/cvedb.py 84.25% <0.00%> (-0.79%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9a4ef49...de9e8d6. Read the comment docs.

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of small comments here, but overall this is looking good.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
| netpbm | nginx | node | openafs | openldap | openssh | openssl |
| openswan | openvpn | png | polarssl_fedora | postgresql | python | qt |
| radare2 | rsyslog | samba | sqlite | strongswan | syslogng | systemd |
| tcpdump | varnish | wireshark | xerces | xml2 | zlib | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: should we even list them here? I don't really mind for ease of searching, but the list is starting to get pretty long and I'm wondering if we're at the point where we may wish to just tell people how to get the list rather than showing it in the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason I have made table was the same because points are taking to much space and I agree list is only going to increase so a solution would be to redirect user to checkers directory.

doc/MANUAL.md Outdated Show resolved Hide resolved
doc/MANUAL.md Outdated

The last release of this tool to support python 2.7 is 0.3.1. Please use
python 3.6+ for development and future versions. Linux and Windows are
The last release of this tool to support python 2.7 is 0.3.1. Please use
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I think it's a waste of time to switch to one space after period when most of the doc is two and the rendering will look the same anyhow.

doc/MANUAL.md Outdated Show resolved Hide resolved
doc/MANUAL.md Outdated Show resolved Hide resolved
doc/MANUAL.md Outdated Show resolved Hide resolved
Co-authored-by: Terri Oda <terri@toybox.ca>
Update README.md

Co-authored-by: Terri Oda <terri@toybox.ca>
Update README.md

Co-authored-by: Terri Oda <terri@toybox.ca>
Update README.md

Co-authored-by: Terri Oda <terri@toybox.ca>
Update doc/MANUAL.md

Co-authored-by: Terri Oda <terri@toybox.ca>
Update doc/MANUAL.md

Co-authored-by: Terri Oda <terri@toybox.ca>
update docs
update doc/MANUAL.md
update manual.md
update manual
accessibility change
update
Comment on lines +358 to +370
<figure>
<img src="https://i.imgur.com/UwH6vA7.png"
alt="
cve-bin-tool: Report Generated: 2020-07-31 17:49:56
1. NewFound CVEs:
Vendor, Product, Version, CVE Number , Severity
haxx , curl , 7.34.0 , CVE-2014-0138, HIGH
haxx , curl , 7.34.0 , CVE-2014-0139, CRITICAL
haxx , curl , 7.34.0 , CVE-2014-0015, MEDIUM
"
style="width:100%;white-space:pre;">
<figcaption>formated console output</figcaption>
</figure>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have any easy way to do this in markdown. So, I am using html here since github supports it.

@pdxjohnny pdxjohnny merged commit b9e41f5 into intel:master Aug 12, 2020
@Niraj-Kamdar Niraj-Kamdar deleted the docs branch August 13, 2020 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for new input_engine.
4 participants