mirrors/pferd
1
0
Fork 0
mirror of https://github.com/Garmelon/PFERD.git synced 2023-12-21 10:23:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add migration notes to changelog

Browse Source 
Also clean up some other formatting for consistency
This commit is contained in:
Joscha 2021-06-13 15:06:50 +02:00
parent 601e4b936b
commit 70b33ecfd9
3 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -22,6 +22,11 @@ ambiguous situations.
## Unreleased ## Unreleased
If your config file doesn't do weird things with transforms, it should continue
to work. If your `-re->` arrows behave weirdly, try replacing them with
`-exact-re->` arrows. If you're on Windows, you might need to switch from `\`
path separators to `/` in your regex rules.
### Added ### Added
- `skip` option for crawlers - `skip` option for crawlers
- Rules with `>>` instead of `>` as arrow head - Rules with `>>` instead of `>` as arrow head

6
CONFIG.md
View File

@ -342,7 +342,8 @@ Example: `\..+ -name-re-> !`
### The `-exact-re->` arrow ### The `-exact-re->` arrow
The `-exact-re>` arrow is like a combination of the `-exact->` and `-re->` arrows. The `-exact-re>` arrow is like a combination of the `-exact->` and `-re->`
arrows.
Example: `f(oo+)/be?ar -exactre-> B{g1.upper()}H/fear` Example: `f(oo+)/be?ar -exactre-> B{g1.upper()}H/fear`
- Doesn't match `a/foo/bar`, `foo/abc/bar`, `afoo/bar` or `foo/bars` - Doesn't match `a/foo/bar`, `foo/abc/bar`, `afoo/bar` or `foo/bars`
@ -375,8 +376,7 @@ tutorials --> !
The second rule is required for many crawlers since they use the rules to decide The second rule is required for many crawlers since they use the rules to decide
which directories to crawl. If it was missing when the crawler looks at which directories to crawl. If it was missing when the crawler looks at
`tutorials/`, the third rule would match. This means the crawler would not crawl `tutorials/`, the third rule would match. This means the crawler would not crawl
the `tutorials/` directory and thus not discover that `tutorials/tut02/` the `tutorials/` directory and thus not discover that `tutorials/tut02/` exists.
exists.
Since the second rule is only relevant for crawling, the `TARGET` is left out. Since the second rule is only relevant for crawling, the `TARGET` is left out.

6
README.md
View File

@ -28,9 +28,9 @@ The use of [venv](https://docs.python.org/3/library/venv.html) is recommended.
## Basic usage ## Basic usage
PFERD can be run directly from the command line with no config file. PFERD can be run directly from the command line with no config file. Run `pferd
Run `pferd -h` to get an overview of available commands and options. -h` to get an overview of available commands and options. Run `pferd <command>
Run `pferd <command> -h` to see which options a command has. -h` to see which options a command has.
For example, you can download your personal desktop from the KIT ILIAS like For example, you can download your personal desktop from the KIT ILIAS like
this: this: