WEBDIENSTE/volatility3
1
0
Fork 0
mirror of https://github.com/volatilityfoundation/volatility3.git synced 2026-08-17 20:35:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fix remaining volatility path issues

Browse Source
This commit is contained in:
Mike Auty
2021-01-30 13:47:00 +00:00
parent 888ed1fbb8
commit cc58360ebb
4 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -77,7 +77,7 @@ The hashes to verify whether any of the symbol pack files have downloaded succes
<https://downloads.volatilityfoundation.org/volatility3/symbols/SHA1SUMS>
<https://downloads.volatilityfoundation.org/volatility3/symbols/MD5SUMS>
Symbol tables zip files must be placed, as named, into the `volatility/symbols` directory (or just the symbols directory next to the executable file).
Symbol tables zip files must be placed, as named, into the `volatility3/symbols` directory (or just the symbols directory next to the executable file).
Windows symbols that cannot be found will be queried, downloaded, generated and cached. Mac and Linux symbol tables must be manually produced by a tool such as [dwarf2json](https://github.com/volatilityfoundation/dwarf2json).
doc/source/complex-plugin.rst
+1 -1
View File
@@ -115,7 +115,7 @@ Constructing an appropriate file, the file can be loaded into a symbol table as
table_name = intermed.IntermediateSymbolTable.create(context, config_path, 'sub_path', 'filename')
This code will load a JSON file from one of the standard symbol paths (volatility/symbols and volatility/framework/symbols)
This code will load a JSON file from one of the standard symbol paths (volatility3/symbols and volatility3/framework/symbols)
under the additional directory sub_path, with a name matching filename.json
(the extension should not be included in the filename).
doc/source/symbol-tables.rst
+2 -2
View File
@@ -12,7 +12,7 @@ Volatility will automatically decompress them on use. It will also cache their
under the user's home directory, in :file:`.cache/volatility3`, along with other useful data. The cache directory currently
cannot be altered.
Symbol table JSON files live, by default, under the :file:`volatility/symbols`, underneath an operating system directory
Symbol table JSON files live, by default, under the :file:`volatility3/symbols`, underneath an operating system directory
(currently one of :file:`windows`, :file:`mac` or :file:`linux`). The symbols directory is configurable within the framework and can
usually be set within the user interface.
@@ -33,7 +33,7 @@ Windows symbol tables can be manually constructed from an appropriate PDB file.
is built into Volatility 3, called :file:`pdbconv.py`. It can be run from the top-level Volatility path, using the
following command:
:command:`PYTHONPATH="." python volatility/framework/symbols/windows/pdbconv.py`
:command:`PYTHONPATH="." python volatility3/framework/symbols/windows/pdbconv.py`
The :envvar:`PYTHONPATH` environment variable is not required if the Volatility library is installed in the system's library path
or a virtual environment.
setup.py
+1 -1
View File
@@ -16,7 +16,7 @@ setuptools.setup(name = "volatility3",
url = "https://volatilityfoundation.org/volatility/",
project_urls = {
"Bug Tracker": "https://github.com/volatilityfoundation/volatility3/issues",
"Documentation": "https://volatilityfoundation.org/volatility/docs/",
"Documentation": "https://volatility3.readthedocs.io/",
"Source Code": "https://github.com/volatilityfoundation/volatility3",
},
include_package_data = True,