Skip to content

Commit cc58360

Browse files
committed
Documentation fix remaining volatility path issues
1 parent 888ed1f commit cc58360

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The hashes to verify whether any of the symbol pack files have downloaded succes
7777
<https://downloads.volatilityfoundation.org/volatility3/symbols/SHA1SUMS>
7878
<https://downloads.volatilityfoundation.org/volatility3/symbols/MD5SUMS>
7979

80-
Symbol tables zip files must be placed, as named, into the `volatility/symbols` directory (or just the symbols directory next to the executable file).
80+
Symbol tables zip files must be placed, as named, into the `volatility3/symbols` directory (or just the symbols directory next to the executable file).
8181

8282
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).
8383

doc/source/complex-plugin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Constructing an appropriate file, the file can be loaded into a symbol table as
115115
116116
table_name = intermed.IntermediateSymbolTable.create(context, config_path, 'sub_path', 'filename')
117117
118-
This code will load a JSON file from one of the standard symbol paths (volatility/symbols and volatility/framework/symbols)
118+
This code will load a JSON file from one of the standard symbol paths (volatility3/symbols and volatility3/framework/symbols)
119119
under the additional directory sub_path, with a name matching filename.json
120120
(the extension should not be included in the filename).
121121

doc/source/symbol-tables.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Volatility will automatically decompress them on use. It will also cache their
1212
under the user's home directory, in :file:`.cache/volatility3`, along with other useful data. The cache directory currently
1313
cannot be altered.
1414

15-
Symbol table JSON files live, by default, under the :file:`volatility/symbols`, underneath an operating system directory
15+
Symbol table JSON files live, by default, under the :file:`volatility3/symbols`, underneath an operating system directory
1616
(currently one of :file:`windows`, :file:`mac` or :file:`linux`). The symbols directory is configurable within the framework and can
1717
usually be set within the user interface.
1818

@@ -33,7 +33,7 @@ Windows symbol tables can be manually constructed from an appropriate PDB file.
3333
is built into Volatility 3, called :file:`pdbconv.py`. It can be run from the top-level Volatility path, using the
3434
following command:
3535

36-
:command:`PYTHONPATH="." python volatility/framework/symbols/windows/pdbconv.py`
36+
:command:`PYTHONPATH="." python volatility3/framework/symbols/windows/pdbconv.py`
3737

3838
The :envvar:`PYTHONPATH` environment variable is not required if the Volatility library is installed in the system's library path
3939
or a virtual environment.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
url = "https://volatilityfoundation.org/volatility/",
1717
project_urls = {
1818
"Bug Tracker": "https://github.com/volatilityfoundation/volatility3/issues",
19-
"Documentation": "https://volatilityfoundation.org/volatility/docs/",
19+
"Documentation": "https://volatility3.readthedocs.io/",
2020
"Source Code": "https://github.com/volatilityfoundation/volatility3",
2121
},
2222
include_package_data = True,

0 commit comments

Comments
 (0)