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

CLI Options Reference for v3.1.1 #27

Merged
merged 24 commits into from
Oct 22, 2019
Merged

CLI Options Reference for v3.1.1 #27

merged 24 commits into from
Oct 22, 2019

Commits on Sep 16, 2019

  1. Documentation Style Enforced for Scancode-Toolkit 

    Documentation Style is enforced by using Doc8 and Doc Contribution Guide is updated accordingly.
300+ Style errors fixed.

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 16, 2019
    Configuration menu
    Copy the full SHA
    b049637 View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2019

  1. Adds New Tutorials and Updates other for Version 3.1.1 

    This commit adds to the Scancode Version 3.1.1 doc branch -> 2 main sample tutorials, How to Run a Scan, and
How to Visualize Scan Results. It also makes changes to How to Format Scan output and How to Set what will be
Detected in a Scan to be compatible with Scancode version 3.1.1, and adds images/gifs (May be updated later).
Also adds minor links/referances.

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 24, 2019
    Configuration menu
    Copy the full SHA
    ab4f8e2 View commit details
    Browse the repository at this point in the history

  2. Adds Minor Changes 

    This commit Adds minor changes to Doc Version 3.1.1 which doesn't belong to CLI options or
the Basic Tutorials. CLI options are to be added next.

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 24, 2019
    Configuration menu
    Copy the full SHA
    311b7be View commit details
    Browse the repository at this point in the history

  3. Adds Command Line Options List for Scancode 3.1.1 

    This commit Adds to the Scancode Doc 3.1.1 rst-snippets, which contains major sections in CLI options,
to be included in list-options.rst(also added in this commit) and other major CLI Options pages.

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 24, 2019
    Configuration menu
    Copy the full SHA
    7936863 View commit details
    Browse the repository at this point in the history

  4. Adds Synopsis, Help Options, Simple Example and Images/Gifs 

    This commit adds to Scancode Doc version 3.1.1 a Synopsis page, Getting Help From Command Line Page,
Includes the How to Perform a scan Tutorial as an example, and adds Gifs/Images (some outdated ones
will be replaced later).

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 24, 2019
    Configuration menu
    Copy the full SHA
    39e769d View commit details
    Browse the repository at this point in the history

Commits on Sep 25, 2019

  1. Adds Scancode Version 3.1.1 Output Formats 

    This commit adds to the Scancode Version 3.1.1 docs, A page detailing all the output formats.
Also modifies rst_snippets related to the custom_output format case.
(An Error present, marked [ToDo], will be solved)

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 25, 2019
    Configuration menu
    Copy the full SHA
    a50d74b View commit details
    Browse the repository at this point in the history

  2. Adds Core Options, Output Filters/Control, Post/Pre Scan Options Pages 

    This commit adds to Scancode Doc Version 3.1.1, pages for  Core Options, Output Filters and OutputControl,
Post Scan Options, and Pre Scan Options Pages.

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 25, 2019
    Configuration menu
    Copy the full SHA
    a342a43 View commit details
    Browse the repository at this point in the history

  3. Sets Version 3.1.1 to Doc8 standards Compliant 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Sep 25, 2019
    Configuration menu
    Copy the full SHA
    7821ccd View commit details
    Browse the repository at this point in the history

Commits on Oct 15, 2019

  1. Adds RST Snippets and Image Data For Scancode-Toolkit CLI 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    ecc8f83 View commit details
    Browse the repository at this point in the history

  2. Adds Minor Changes to Scancode CLI Options 

    This commit adds minor changes to contrib_doc.rst, and at cli-referance/, adds changes to
synopsis, index and help-text-options.

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    2b1b00b View commit details
    Browse the repository at this point in the history

  3. Adds Core Options Page to CLI referance 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    70bda0e View commit details
    Browse the repository at this point in the history

  4. Adds Pre-Scan CLI Options Referance 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    1001b58 View commit details
    Browse the repository at this point in the history

  5. Adds Post-Scan CLI Options Referance 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    395debb View commit details
    Browse the repository at this point in the history

  6. Adds Output Filters and Control page to CLI referance 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    af0e85b View commit details
    Browse the repository at this point in the history

  7. Adds Output Formats in CLI referance 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    084f8a9 View commit details
    Browse the repository at this point in the history

  8. Merge branch 'master' into v3.1.1 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    0c91358 View commit details
    Browse the repository at this point in the history

Commits on Oct 17, 2019

  1. Fix minor Style Problems and Update License Template Option 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 17, 2019
    Configuration menu
    Copy the full SHA
    948eace View commit details
    Browse the repository at this point in the history

Commits on Oct 18, 2019

  1. Add modifications to rst_snippets 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 18, 2019
    Configuration menu
    Copy the full SHA
    11ac684 View commit details
    Browse the repository at this point in the history

  2. Add Options dependency support and other Modifications/Fixes 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 18, 2019
    Configuration menu
    Copy the full SHA
    012fc0f View commit details
    Browse the repository at this point in the history

Commits on Oct 19, 2019

  1. Add JSON Model Snippets and Delete Screenshots 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 19, 2019
    Configuration menu
    Copy the full SHA
    4524ed2 View commit details
    Browse the repository at this point in the history

Commits on Oct 20, 2019

  1. Add minor fixes 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 20, 2019
    Configuration menu
    Copy the full SHA
    aa74646 View commit details
    Browse the repository at this point in the history

  2. Fix Spelling and Grammer Errors 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 20, 2019
    Configuration menu
    Copy the full SHA
    50da75b View commit details
    Browse the repository at this point in the history

  3. Enforce doc standards 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 20, 2019
    Configuration menu
    Copy the full SHA
    3942d68 View commit details
    Browse the repository at this point in the history

  4. Add requirements.txt file for RTD build 

    Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
    @AyanSinhaMahapatra
    AyanSinhaMahapatra committed Oct 20, 2019
    Configuration menu
    Copy the full SHA
    810dd0b View commit details
    Browse the repository at this point in the history