Skip to content

Commit a6d40e6

Browse files
committed
fix renaming typos
1 parent 8fe0fe2 commit a6d40e6

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

libxdk/target/KxdbParser.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class KxdbParser: protected BinaryReader {
3030
std::map<uint64_t, Struct> struct_layouts_;
3131

3232
/**
33-
* @brief Parses the symbols header section of the XdkDevice file.
33+
* @brief Parses the symbols header section of the KXDB file.
3434
* @details Reads the number of symbols and their metadata, storing the symbol names.
3535
* @throws ExpKitError if there's an error reading the binary data.
3636
*/
@@ -45,7 +45,7 @@ class KxdbParser: protected BinaryReader {
4545
void ParseSymbols(Target& target);
4646

4747
/**
48-
* @brief Parses the ROP actions header section of the XdkDevice file.
48+
* @brief Parses the ROP actions header section of the KXDB file.
4949
* @details Reads the number of ROP actions and their metadata, storing the ROP action IDs and optionally parsing detailed metadata.
5050
* @param parse_known_metadata If true, parses the description and arguments for each ROP action.
5151
* @throws ExpKitError if there's an error reading the binary data.
@@ -76,7 +76,7 @@ class KxdbParser: protected BinaryReader {
7676
void ParsePivots(Target& target);
7777

7878
/**
79-
* @brief Parses the structs header section of the XdkDevice file.
79+
* @brief Parses the structs header section of the KXDB file.
8080
* @details Reads the metadata for each struct, including its name and fields, and stores it. Also reads the offset to the struct layouts.
8181
* @throws ExpKitError if there's an error reading the binary data.
8282
*/
@@ -107,7 +107,7 @@ class KxdbParser: protected BinaryReader {
107107
void ParseStructs(Target& target);
108108

109109
/**
110-
* @brief Parses targets from the XdkDevice file that match the optional filter criteria.
110+
* @brief Parses targets from the KXDB file that match the optional filter criteria.
111111
* @param distro Optional filter for the distribution name.
112112
* @param release_name Optional filter for the release name.
113113
* @param version Optional filter for the version string.
@@ -138,20 +138,20 @@ class KxdbParser: protected BinaryReader {
138138

139139
/**
140140
* @brief Constructs a KxdbParser from a buffer.
141-
* @param buffer The buffer containing the XdkDevice data.
141+
* @param buffer The buffer containing the KXDB data.
142142
* @param size The size of the buffer.
143143
*/
144144
KxdbParser(const uint8_t* buffer, size_t size);
145145

146146
/**
147147
* @brief Constructs a KxdbParser from a vector of bytes.
148-
* @param data The vector containing the XdkDevice data.
148+
* @param data The vector containing the KXDB data.
149149
*/
150150
KxdbParser(const std::vector<uint8_t> data);
151151

152152
/**
153153
* @brief Constructs a KxdbParser by reading data from a file.
154-
* @param filename The path to the XdkDevice file.
154+
* @param filename The path to the KXDB file.
155155
* @return A KxdbParser object initialized with the file's content.
156156
* @throws ExpKitError if the file cannot be read.
157157
*/
@@ -163,7 +163,7 @@ class KxdbParser: protected BinaryReader {
163163
void SetLog(ILog* log);
164164

165165
/**
166-
* @brief Parses the header section of the XdkDevice file.
166+
* @brief Parses the header section of the KXDB file.
167167
* @details Reads the magic number, version, and the offsets to the different data sections (symbols, ROP actions, structs, targets). Optionally parses known metadata.
168168
* @param parse_known_metadata If true, parses detailed metadata for ROP actions.
169169
* @throws ExpKitError if the magic number is invalid, the version is unsupported, or there's an error reading the binary data.
@@ -193,7 +193,7 @@ class KxdbParser: protected BinaryReader {
193193
bool throw_on_missing = false);
194194

195195
/**
196-
* @brief Retrieves all targets available in the XdkDevice file.
196+
* @brief Retrieves all targets available in the KXDB file.
197197
* @return A vector of all Target objects found in the file.
198198
*/
199199
std::vector<Target> GetAllTargets();

third_party/kernel-modules/xdk_device/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,15 +251,15 @@ Which results in a crash like (ROP chain item is executed):
251251
252252
## Automatically with kernel-image-runner
253253
254-
If you run `./run.sh` with `--custom-modules=xkd_device`, the module will be compiled and loaded automatically.
254+
If you run `./run.sh` with `--custom-modules=xdk_device`, the module will be compiled and loaded automatically.
255255
256256
## Manually for kernel-image-runner targets
257257
258-
Run `./compile_custom_modules.sh (kernelctf|ubuntu) <release-name> xkd_device` and after the compilation process, the compiled module can be found at `rootfs/custom_modules/xkd_device.ko`.
258+
Run `./compile_custom_modules.sh (kernelctf|ubuntu) <release-name> xdk_device` and after the compilation process, the compiled module can be found at `rootfs/custom_modules/xdk_device.ko`.
259259
260260
## Manually for custom kernels
261261
262262
Compile your kernel normally and then execute the following command from the same directory where you compiled your kernel (replace `<kernel-image-runner-dir>` with the root directory of the kernel-image-runner):
263263
264-
`make M=<kernel-image-runner-dir>/../third_party/kernel-modules/xkd_device modules`
264+
`make M=<kernel-image-runner-dir>/../third_party/kernel-modules/xdk_device modules`
265265

0 commit comments

Comments
 (0)