Commit Graph
71 Commits
Author SHA1 Message Date
Mike Auty 754cfcd7ac Documentation: Add more detail on writing objects
Fixes #390
2020-12-06 23:55:49 +00:00
Mike Auty 3b700bbee5 Documentation: Ensure non-os plugins are documented 2020-12-06 23:55:26 +00:00
Mike Auty f9345acf43 Documentation: Document how to handle files 2020-10-29 09:43:16 +00:00
Mike Auty ea629591ef Plugins: Make open method clearer to use
This highlights that the FileHandler class can also be seen as a method
similar to open, and it removes unnecessary context managers, allowing
plugins to close files as they wish (they must, however, remember to
close the file for it to be committed).
2020-10-29 09:43:16 +00:00
Mike Auty e8fb8c929c Plugins: Introduce FileHandlerInterface 2020-10-29 09:43:16 +00:00
Mike Auty 054a3618b8 Documentation: Fix missing construct_plugin 2020-10-28 22:59:13 +00:00
Mike Auty 523156670d Documentation: Clarify the mapping output parameters 2020-08-16 00:50:17 +01:00
Mike Auty 4c3bf7222e Documentation: Describe the various AbsentValues. 2020-08-10 23:04:18 +01:00
Mike Auty 49e778724b Documentation: Add in section about TreeGrid column types 2020-08-10 22:36:20 +01:00
Mike Auty 77101c5617 Documentation: Slight code fix in the library page 2020-08-10 22:22:25 +01:00
Mike Auty 03d69204f3 Documentation: Add in using volatility as a library 2020-08-10 22:17:40 +01:00
Mike Auty d6442d661f Documentation: Document self.config slightly better 2020-07-26 23:16:23 +01:00
Mike Auty 9295f41586 Plugins: Convert existing plugins over to use a list for PIDs 2020-07-23 02:02:01 +01:00
Mike Auty 10f6231c87 Documentation: Fix typo (thanks NiklasBeierl!) 2020-07-11 19:34:42 +01:00
Mike Auty 878e4c0420 Documentation: Improve the man page regarding issue #250. 2020-07-11 12:16:24 +01:00
Mike Auty ce6fb561cb Documentation: Add an important note about layer.metadata 2020-07-05 22:20:26 +01:00
Mike Auty ea20ae1c0c Docs: Add CLI manpage (and fix a CLI option) 2020-06-28 00:57:46 +01:00
Mike Auty 91d9d37c68 Docs: Document cross-layer communication 2020-06-27 23:52:54 +01:00
Mike Auty 09dd048834 Documentation: Minor fixes for recent documentation 2020-05-10 17:31:26 +01:00
Mike Auty 6e91349c73 Documentation: Add in information about creating layers. 2020-05-09 02:07:08 +01:00
Mike Auty 24e6d7c658 Ensure the documentation doesn't get stale. 2019-10-31 22:14:43 +00:00
Nick L. Petroni, Jrandikelos cf08fef6ad enable readthedocs support 2019-10-14 22:07:28 +01:00
Mike Auty d7b1855099 Ensure the documentation versioning is consistent too. 2019-10-13 11:20:53 +01:00
Mike Auty a0e94dcf0f Last minute fix to the docs not to mention pdb2json. 2019-10-10 15:55:42 +01:00
Nick L. Petroni, Jrandikelos 500b93d876 doc improvements: spelling, capitalization, markup, grammar 2019-10-10 11:19:36 +01:00
Mike Auty b8f22bea7a Add in static list of support formats/architectures. 2019-10-07 02:01:51 +01:00
Mike Auty ade126a4c6 Update documentation to be more accurate about ZIP symbol files. 2019-10-04 23:22:12 +01:00
Mike Auty ea7d9592a9 Initial attempt at symbol table documentation. 2019-10-03 00:36:50 +01:00
Mike Auty 10a379b0ee Make 'import as' consistent and ensure proper plugin dependencies. 2019-10-02 01:25:03 +01:00
Mike Auty 96cd76378e Improve the documentation logo. 2019-09-25 22:21:21 +01:00
Mike Auty ab83e237e6 Add in better quality volatility favicon 2019-09-25 22:08:51 +01:00
Mike Auty e0b9d72c84 Update the license URL and LICENSE.txt 2019-09-25 21:44:05 +01:00
Mike Auty 1153e86f23 Ensure user plugins are in the plugins documentation. 2019-09-19 22:59:28 +01:00
Mike Auty aae1623696 Ensure we only remove autodoc files on clean command. 2019-09-19 22:42:06 +01:00
Mike Auty 3bb2e50f2c Ensure the autodoc generated files are regenerated each run. 2019-09-17 18:33:58 +01:00
Mike Auty a3caf39097 Use a mapping to determine kind to class. 2019-08-31 12:57:53 +01:00
Mike Auty 9cde94bceb Change the license blurb on all files. 2019-08-27 23:11:00 +01:00
Mike Auty 58dffe8795 Fix typos from the rebase, and add documentation. 2019-08-27 21:08:29 +01:00
Mike Auty 1039189f7e More proof reading of the documentation. 2019-08-24 01:10:34 +01:00
Mike Auty 0b6c991b10 Fix up issues in the simple-plugin example. 2019-08-23 21:35:52 +01:00
Mike Auty 4adfffb381 Proof read the basics documentation and add in additional sections to complex. 2019-08-23 12:26:19 +01:00
Mike Auty f8c91fa4da Add in more advanced documentation. 2019-08-20 00:13:16 +01:00
Mike Auty c0f650ba78 Ensure Mac plugins are documented and add complex tasks documentation. 2019-08-18 22:35:34 +01:00
Mike Auty ea7ca23987 Update the documentation generation and sphinx used. 2019-08-18 18:28:34 +01:00
Mike Auty cb57905585 Try out a different style of documentation and options. 2019-08-18 01:20:32 +01:00
Mike Auty 2e7460b683 Fix a typo and slightly reword. 2019-07-17 12:26:35 +01:00
Mike Auty 900bbbb44f Add in additional documentation. 2019-07-17 01:23:32 +01:00
Mike Auty 754b3f0bc6 Refactor create_filter to create_pid_filter. 2019-04-18 01:10:07 +01:00
Mike Auty 2aa07596c2 Fix up filtering in mac and remove the last of the filter shadowing. 2019-02-28 09:48:15 +00:00
Mike Auty 4e8c8a7232 Fix issues with SymbolRequirement refactoring. 2019-02-11 22:30:22 +00:00