Commit Graph

57 Commits

Author SHA1 Message Date
Frinzell, Aaron 307f4ee075 Define PEP515 support
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2023-01-11 16:42:17 -08:00
Nathaniel Mitchell 0c9a50fa5e Update install documentation to reflect compression changes
Signed-off-by: Nathaniel Mitchell <nathaniel.p.mitchell@intel.com>
2022-12-14 13:06:03 -08:00
Nathaniel Mitchell 5d6c3d90ec Add chipsec_main flag for module_exclude
Signed-off-by: Nathaniel Mitchell <nathaniel.p.mitchell@intel.com>
2022-12-14 12:44:43 -08:00
Frinzell, Aaron 468f1893ec Define PEP572 and for-else while-else support
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-12-14 12:43:18 -08:00
Frinzell, Aaron 329112c73a Fix URL typo in style guide
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-11-30 13:46:01 -08:00
Nathaniel Mitchell 4b6a3c5948 Update mailing list and add discord link
Signed-off-by: Nathaniel Mitchell <nathaniel.p.mitchell@intel.com>
2022-10-27 15:32:12 -07:00
Nathaniel Mitchell bef18a75dc Update the wording around the -i flag
Signed-off-by: Nathaniel Mitchell <nathaniel.p.mitchell@intel.com>
2022-10-27 15:32:00 -07:00
Frinzell, Aaron bb67e32f38 Specify f-string support in contribution guide
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-10-26 10:39:58 -07:00
Frinzell, Aaron 8bf6676cac Specify Python version support in code style
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-10-26 10:39:58 -07:00
Frinzell, Aaron f9eaef712d Add applicable Type Hint PEPs to contribution guide
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-10-26 10:39:58 -07:00
Sara Batllori a71483db1b Add VS2022 support to driver and improve documentation
Signed-off-by: Sara Batllori <sara.batllori@intel.com>
2022-08-24 16:11:31 -07:00
Sara Batllori 344043b37d Remove sphinx warnings
Signed-off-by: Sara Batllori <sara.batllori@intel.com>
2022-07-25 17:05:19 -07:00
Sara Batllori 0a3a9a6a20 Consolidate Linux installation documentation
Signed-off-by: Sara Batllori <sara.batllori@intel.com>
2022-07-25 17:05:09 -07:00
Frinzell, Aaron c9145313ea Move command template to chipsec-manual
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-06-21 08:59:21 -07:00
Frinzell, Aaron 29217a5998 Move module template to chipsec-manual
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-06-21 08:59:21 -07:00
Sara Batllori ad35808679 Fix formatting issue in documentation
Signed-off-by: Sara Batllori <sara.batllori@intel.com>
2022-05-31 11:23:43 -07:00
Dan Scott 907009a1d0 Adding back missing lines 2022-05-25 14:28:39 -07:00
Dan Scott 06d2263fd6 Correct list numbering in manual 2022-05-25 14:28:39 -07:00
Frinzell, Aaron 95614d8d53 Add code-block line-feed
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-24 14:06:36 -07:00
Frinzell, Aaron eb33b595f3 Python code style guide
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-24 14:06:36 -07:00
Dan Scott 98fba99622 replace liveusb with rufus 2022-05-24 14:05:21 -07:00
Frinzell, Aaron 4a82a27d3d Add ref and clean up Interpreting-Results.rst
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-18 16:22:13 -07:00
Sara Batllori 1e528be6d1 Add changes to improve documentation
Signed-off-by: Sara Batllori <sara.batllori@intel.com>
2022-05-18 13:14:04 -07:00
Frinzell, Aaron 77c8fff116 Clean up Vulnerabilities-and-CHIPSEC-Modules.rst
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-18 10:08:41 -07:00
Frinzell, Aaron 907f8e4824 clean up
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-17 15:19:30 -07:00
Frinzell, Aaron a74806519e Update EFI manual section
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-05-17 15:19:30 -07:00
Sara Batllori 8ad4185bec Fix sphinx warnings and index version overwrite 2022-04-25 17:04:39 -05:00
Aaron Frinzell c8e7da29f6 Architecture document updates (#1405)
Signed-off-by: Frinzell, Aaron <aaron.frinzell@intel.com>
2022-03-28 12:55:50 -07:00
Sae86 c468134d5d Fix version update for index.rst
Signed-off-by: Sae86 <sara.batllori@intel.com>
2022-02-01 11:29:13 -08:00
Sae86 68bf7653dc Add version to manual html pages
Signed-off-by: Sae86 <sara.batllori@intel.com>
2022-01-27 15:22:44 -08:00
Sae86 84bb5610b0 Update contact information
Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-12-14 08:20:21 -08:00
Aaron Frinzell 4f8444edce Move UEFI Shell to Python 3.6.8 2021-12-08 08:39:32 -08:00
Sae86 947ab238a1 Improvements to sphinx
Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-10-26 15:05:45 -07:00
Sae86 eb37fa0e87 Minor fixes to documentation
Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-09-21 15:39:23 -07:00
Sae86 f704dd0f78 Show only main docstring for modules
Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-09-21 15:31:07 -07:00
Sae86 9281e73532 Update Windows Installation and other improvements
Update win requirements
    Adding info to contact page

Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-06-25 10:16:30 -07:00
Sae86 fbed11ae18 Script enhancements
Signed-off-by: Sae86 <sara.batllori@intel.com>
2021-06-03 21:37:04 -07:00
Sae86 d52ea51fd7 Sphinx update
Modified:
        docs/create_manual.cmd - Add html command and options to build either html or pdf, or both
        docs/sphinx/_templates/scover.tmpl - Update date automatically
        docs/sphinx/_templates/sstylesheet.style - remove references to templates that will no longer be used, add format styles
        docs/sphinx/conf.py - Add several changes for documentation creation. HTML: main doc, copyright year, version and release numbers, html theme options. PDF: increased toc depth
        docs/sphinx/index.rst - Update from Home wiki page
        docs/sphinx/removeStrRst.py - change how titles are shown and more information shown for modules and add a function to update version in scover

Deleted:
        docs/sphinx/_templates/cover.pdf - no longer used
        docs/sphinx/_templates/layout.html - no longer used
        docs/sphinx/_templates/page.pdf - no longer used
        docs/sphinx/_templates/theme.conf - added in conf.py
        docs/sphinx/_images/chipsec.jpg - replaced by architecture.png
        Replaced by imported wiki files:
	    docs/sphinx/compandstruct.rst
	    docs/sphinx/dalinstall.rst
	    docs/sphinx/description.rst
            docs/sphinx/installation.rst
            docs/sphinx/linuxinstall.rst
            docs/sphinx/mod.rst
            docs/sphinx/options.py
            docs/sphinx/options.rst
            docs/sphinx/osxinstall.rst
            docs/sphinx/uefinstall.rst
            docs/sphinx/usage.rst
            docs/sphinx/winstall.rst

Added
        docs/create_manual.sh - Add script version for linux
the following is a list of files imported from the wiki:
        docs/sphinx/Architecture-Overview.rst
        docs/sphinx/Configuration-Files.rst
        docs/sphinx/Developing.rst
        docs/sphinx/Install in DAL Win.rst
        docs/sphinx/Install in Linux.rst
        docs/sphinx/Install in MacOS.rst
        docs/sphinx/Install in Windows.rst
        docs/sphinx/Interpreting-Results.rst
        docs/sphinx/OS-Helpers-and-Drivers.rst
        docs/sphinx/Platform-Detection.rst
        docs/sphinx/Running-Chipsec.rst
        docs/sphinx/USB with UEFI Shell.rst
        docs/sphinx/Using-CHIPSEC-with-Kali-Linux.rst
        docs/sphinx/Vulnerabilities-and-CHIPSEC-Modules.rst
        docs/sphinx/_images/architecture.png

Signed-off-by: Sae86 <sae.batllori@intel.com>
2021-03-31 18:40:27 -07:00
Aaron Frinzell 96745e908b Brackets 2020-11-18 21:13:05 -08:00
Aaron Frinzell 4a1f5e4a4d Update uefinstall.rst URLs 2020-11-18 21:13:05 -08:00
Aaron Frinzell 90a220b22c Document sphinx related updates 2020-10-28 09:52:02 -07:00
brentholtsclaw f7fe1be074 More whitespace cleanup
E231, E201, E226

Signed-off-by: brentholtsclaw <brent.holtsclaw@intel.com>
2020-07-31 13:46:13 -07:00
brentholtsclaw 707d682388 Update uefi shell link within docs directory
Signed-off-by: brentholtsclaw <brent.holtsclaw@intel.com>
2020-07-31 09:27:44 -07:00
Erik Bjorge 7e016af070 Updating version to 1.3.7
Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2019-03-05 17:25:06 -08:00
Erik Bjorge 8ff8f1827e Updated processing of options documentation
With the switch to argparse a number of small issues were seen in the
exported PDF.  This script cleans up some of the formatting issues by
moving the options output to a preformatted/code section.

Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2019-03-05 17:25:06 -08:00
Erik Bjorge 76e08b919c Updated Windows and Linux install information
Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2019-03-05 17:25:06 -08:00
Erik Bjorge 5d3541c005 Additional documentation fixes
- Remove warnings when processing doc strings
- Fix some formatting issues

Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2019-03-05 17:25:06 -08:00
BrentHoltsclaw c37c3b852e Enabling OSX support for common modules and update install
Functionality was added, but the modules were never updated.
2019-01-09 11:00:39 -08:00
Erik Bjorge 4761a38aa2 Updating version to 1.3.6
- Version number updates
- User Manual updates

Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2018-11-20 11:15:03 -08:00
Erik Bjorge 8f68d03cc8 Update DAL install instructions
Signed-off-by: Erik Bjorge <erik.c.bjorge@intel.com>
2018-11-11 19:15:00 -08:00