From cc58360ebb96fcd92456960253966868ccd262c2 Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Sat, 30 Jan 2021 13:47:00 +0000 Subject: [PATCH] Documentation fix remaining volatility path issues --- README.md | 2 +- doc/source/complex-plugin.rst | 2 +- doc/source/symbol-tables.rst | 4 ++-- setup.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1da1d4bdf..f48bf728f 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ The hashes to verify whether any of the symbol pack files have downloaded succes -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). diff --git a/doc/source/complex-plugin.rst b/doc/source/complex-plugin.rst index e7852aaf5..23a45f079 100644 --- a/doc/source/complex-plugin.rst +++ b/doc/source/complex-plugin.rst @@ -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). diff --git a/doc/source/symbol-tables.rst b/doc/source/symbol-tables.rst index 4e44e8368..fd94dea4d 100644 --- a/doc/source/symbol-tables.rst +++ b/doc/source/symbol-tables.rst @@ -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. diff --git a/setup.py b/setup.py index 168c7a4cf..64d9bf2d1 100644 --- a/setup.py +++ b/setup.py @@ -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,