Skip to content

Commit

Permalink
docs: Fix incorrect file paths and refine for better readability (#272)
Browse files Browse the repository at this point in the history
  • Loading branch information
lqhuang authored Dec 6, 2024
1 parent d83a154 commit ef09b44
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/build_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ You can include additional files that are not normally installed inside site-pac
[tool.pdm.build.wheel-data]
# Install all files under scripts/ to the $prefix/bin directory.
scripts = ["scripts/*"]
# Install all *.h files under headers/ (recursively) to the $prefix/include directory,
# Recursively install all *.h files from headers/ to the $prefix/include directory,
# flattening all files into one directory:
# headers/folder1/file1.h -> $prefix/include/file1.h
# headers/folder2/file2.h -> $prefix/include/file2.h
Expand All @@ -225,17 +225,17 @@ Advanced examples:

```toml
[tool.pdm.build.wheel-data]
# Install all *.h files under headers/ (recursively) to the $prefix/include directory,
# keeping the directory structure (thanks to relative-to).
# Recursively install all *.h files under headers/ to the $prefix/include directory,
# while preserving the directory structure (thanks to relative-to).
# We make the destination paths relative to "headers"
# so that "headers" does not appear in the destination paths:
# headers/folder1/file1.h -> $prefix/include/folder1/file1.h
include = [{path = "headers/**/*.h", relative-to = "headers/"}]
# Install all files under share/ (recursively) to the $prefix/data directory,
# keeping the directory structure (thanks to relative-to).
# Recursively install all files from share/ to the $prefix/data directory,
# while preserving the directory structure (thanks to relative-to).
# We make the destination paths relative to "."
# to preserve the exact same directory structure in the destination:
# share/man/man1/project.1 -> $prefix/data/share/man/man1/project.1
# share/man/man1/project.1 -> $prefix/share/man/man1/project.1
data = [{path = "share/**/*", relative-to = "."}]
```

Expand Down

0 comments on commit ef09b44

Please sign in to comment.