Skip to content

Commit 4511651

Browse files
committed
replace relative links with absolute ones in docs to be usable in wiki
1 parent 3b2b2b2 commit 4511651

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# LZ4 Scatter-Gather (SG) Buffers Support in Linux Kernel block layer
22

3-
This project extends the LZ4 compression algorithm implementation in the Linux kernel to support SG-buffers (based on `struct bio_vec`),
3+
This project extends the LZ4 compression algorithm implementation in the Linux kernel to support SG-buffers (based on `struct bio_vec`),
44
eliminating the need for additional data copying.
55

66
## Key Features
77

88
- Kernel-space implementation of LZ4 with SG buffers support
99
- Block device module for tests and experiments
1010
- Test environment for validation
11-
- API extension in `lz4e/include/lz4e.h`
11+
- API extension in [`lz4e/include/lz4e.h`](https://github.com/ItIsMrLaG/lz4-sgori/blob/main/lz4e/include/lz4e.h)
1212

1313
## Extended API
1414

doc/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,4 @@ For I/O, iterators can be created and modified before calling the function and a
100100
runtime to contain current position after the function is called.
101101
Compression requires additional 1KB of working memory on top of existing 16KB, the exact size is in macro `LZ4E_MEM_COMPRESS`.
102102
103-
Described signatures and macros can be found at [lz4e.h](../lz4e/include/lz4e.h).
103+
Described signatures and macros can be found at [lz4e.h](https://github.com/ItIsMrLaG/lz4-sgori/blob/main/lz4e/include/lz4e.h).

doc/Usage.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,12 @@ inserted into your kernel. After that, to be able to access exported symbols you
7878
See more details: <https://docs.kernel.org/kbuild/modules.html#symbols-from-another-external-module>.
7979

8080
As examples for both cases, you can see how the block dev module is compiled when running `make` and `make bdev`:
81-
- [top-module Kbuild](../Kbuild);
82-
- [setting KBUILD_EXTRA_SYMBOLS](../lz4e_bdev/Kbuild).
81+
- [top-module Kbuild](https://github.com/ItIsMrLaG/lz4-sgori/blob/main/Kbuild);
82+
- [setting KBUILD_EXTRA_SYMBOLS](https://github.com/ItIsMrLaG/lz4-sgori/blob/main/lz4e_bdev/Kbuild).
8383

84-
After the symbols can be accessed by your module, to use functions provided by the header [`lz4e.h`](../lz4e/include/lz4e.h) you can add it to your includes
85-
using gcc's `-I` flag, or by directly copying it into your sources.
84+
After the symbols can be accessed by your module, to use functions provided by the header
85+
[`lz4e.h`](https://github.com/ItIsMrLaG/lz4-sgori/blob/main/lz4e/include/lz4e.h)
86+
you can add it to your includes using gcc's `-I` flag, or by directly copying it into your sources.
8687

8788
## Using the block device
8889

0 commit comments

Comments
 (0)