Skip to content

Commit 694ae98

Browse files
committed
Fix all links
1 parent 7579469 commit 694ae98

File tree

10 files changed

+64
-64
lines changed

10 files changed

+64
-64
lines changed

src/mini-tutorials/how-to-add-completions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ or somewhere else. Or they might not be documented at all.
4444
Sometimes the build system needs to generate completions.
4545

4646
This should be familiar to you if you've read my [xbps-src packaging
47-
tutorial](xbps-src-packaging-tutorial.md), because it's used in
48-
[`bat`](packaging-bat.md) itself.
47+
tutorial](../xbps-src-tutorial/index.md), because it's used in
48+
[`bat`](../xbps-src-tutorial/packaging-bat.md) itself.
4949

5050
A disadvantage of this approach is that the shell completion generation might
5151
have extra dependencies or it might require tweaking (like setting
5252
`BAT_ASSETS_GEN_DIR` in
53-
[`bat`](packaging-bat.md#installing-supplementary-files)).
53+
[`bat`](../xbps-src-tutorial/packaging-bat.md#installing-supplementary-files)).
5454

5555
If the build system generates completions, it also usually installs them. But
5656
this isn't the case in `bat` for example.
@@ -70,7 +70,7 @@ As you sure remember, you can't run programs compiled for target architecture on
7070
host. If the program is compiled (`hatch` mentioned above isn't by the way, so
7171
the following advice doesn't apply to it), you'll have to use `build_helper=qemu`.
7272

73-
This is described in [tips and tricks](tips_and_tricks.md#qemu).
73+
This is described in [tips and tricks](../tips_and_tricks.md#qemu).
7474

7575
This is used in
7676
[`mdBook`](https://github.com/void-linux/void-packages/blob/3ddc63b10ff4f7a574996a3a43952c39c732101f/srcpkgs/mdBook/template#L18-L21)

src/mini-tutorials/how-to-fetch-git-submodules.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ that breakage won't occur, you should replace the submodule with actual packaged
1212
dependency.
1313

1414
If you choose this path, you will likely have to [patch the build
15-
system](packaging-j4-dmenu-desktop.md#when-their-build-system-is-broken) or
16-
modify it in some other way to accept the packaged dependency. If you are
15+
system](../xbps-src-tutorial/packaging-j4-dmenu-desktop.md#when-their-build-system-is-broken)
16+
or modify it in some other way to accept the packaged dependency. If you are
1717
knowledgable of git submodules and upstream's build system, you could propose a
1818
more packaging friendly way to handle dependencies [to
19-
upstream](troubleshooting.md#notifying-upstream).
19+
upstream](../troubleshooting.md#notifying-upstream).
2020

2121
But if the project is using a old version of the submodule or a customized one,
2222
this likely won't be possible. The submodule also might not be packaged.
2323

2424
Header only libraries also [don't really meet the quality
25-
requirements](packaging-j4-dmenu-desktop.md#quality-requirements) (but it
25+
requirements](../xbps-src-tutorial/packaging-j4-dmenu-desktop.md#quality-requirements) (but it
2626
depends), so packaging them as a dependency might not be reasonable. Leaving the
2727
header only dependency as a git submodule is preferable in this scenario.
2828

@@ -52,11 +52,11 @@ second method is [using plain `git`](#using-git).
5252
### Using GitHub UI
5353
Go to the release the package is using (here it's the latest release `v0.3.3`):
5454

55-
![main page](images/git_submodules/main_page.png)
55+
![main page](../images/git_submodules/main_page.png)
5656

5757
Click on the associated tag:
5858

59-
![release tag](images/git_submodules/release_tag.png)
59+
![release tag](../images/git_submodules/release_tag.png)
6060

6161
This will take you back to the repository in the state it was when the release
6262
was made.
@@ -73,14 +73,14 @@ located. `gazou`'s `.gitmodules` looks like this:
7373

7474
You should return to the root of the repository. You must click on the correct link:
7575

76-
![return](images/git_submodules/return.png)
76+
![return](../images/git_submodules/return.png)
7777

7878
If you click on the link crossed out on the picture, you will return to master
7979
and you will no longer be browsing the repo at the specified commit.
8080

8181
You should go to the directories where the submodules should be:
8282

83-
![submodule commit](images/git_submodules/submodule_commit.png)
83+
![submodule commit](../images/git_submodules/submodule_commit.png)
8484

8585
You should also make sure that you are still checked out to the release. The
8686
green box shouldn't contain `master` nor `main`. It should be a tag.
@@ -99,24 +99,24 @@ This hash is usable, but you should make sure that the commit isn't tied to a
9999
tag. Tags should be preferred over commit hashes because they are nicer and
100100
shorted. To do that, click on the top commit:
101101

102-
![tag commit](images/git_submodules/tag_commit.png)
102+
![tag commit](../images/git_submodules/tag_commit.png)
103103

104104
You should see whether there is a tag listed:
105105

106-
![tagged pin](images/git_submodules/tagged_pin.png)
106+
![tagged pin](../images/git_submodules/tagged_pin.png)
107107

108108
If it isn't (it is on the picture), return to the root of the repo while
109109
preserving the checkout like before and proceed with [getting the
110110
archive](#getting-the-archive).
111111

112112
Click on the tag. If you get brought to a release page, click on the tag again:
113113

114-
![next tag](images/git_submodules/next_tag.png)
114+
![next tag](../images/git_submodules/next_tag.png)
115115

116116
#### Getting the archive
117117
Click on "Code" and copy the link for downloading ZIP:
118118

119-
![get link](images/git_submodules/get_link.png)
119+
![get link](../images/git_submodules/get_link.png)
120120

121121
This is the link to download the submodule. Note that `void-packages` prefers
122122
`.tar.gz` archives instead of `.zip` archives. GitHub has no button for that,
@@ -298,4 +298,4 @@ to change the name of the downloaded archive. They are then put into
298298
`build_wrksrc` can be used to tell `xbps-src` which of the extracted
299299
directories should be treated as the primary one. [CWD is set to
300300
`build_wrksrc` in some build
301-
steps.](packaging-j4-dmenu-desktop.md#cwd)
301+
steps.](../xbps-src-tutorial/packaging-j4-dmenu-desktop.md#cwd)

src/package-update-tutorial.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ the project has one.
299299
It might be necessary to modify the template to fix the build. There is no
300300
universal way to fix these problems, but general understanding of `xbps-src` is
301301
helpful in these situations. I recommend you reading the [xbps-src packaging
302-
tutorial](xbps-src-packaging-tutorial.md).
302+
tutorial](xbps-src-tutorial/index.md).
303303

304304
## `xlint`
305305
You should always run `xlint` when finishing a package. It can find common
@@ -318,10 +318,10 @@ haven't caused the warnings), it is tolerable to leave the warning be. You
318318
should make a comment about it in the pull request description.
319319

320320
## Making a pull request
321-
Contributing is described at [Contributing](contributing.md). You should already
321+
Contributing is described at [Contributing](xbps-src-tutorial/contributing.md). You should already
322322
have a working clone of your fork, the `upstream` remote should be set up and
323323
you should be on a non-default branch. You can skip these parts in
324-
[Contributing](contributing.md).
324+
[Contributing](xbps-src-tutorial/contributing.md).
325325

326326
[You should ensure that the branch is up to date.](troubleshooting.md#being-up-to-date)
327327

@@ -380,4 +380,4 @@ It will output a link that will open the pull request.
380380
[different ways of cloning](tips_and_tricks.md#different-ways-of-cloning).
381381
[^remotes]: This is briefly described in the [remotes section of contributing
382382
(of this tutorial, not void-packages'
383-
CONTRIBUTING)](contributing.md#remotes)
383+
CONTRIBUTING)](xbps-src-tutorial/contributing.md#remotes)

src/tips_and_tricks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The following architectures are checked:
116116

117117
I assume you are on `x86_64` (I make this assumption in the entire tutorial as
118118
I've mentioned in
119-
[j4-dmenu-desktop](packaging-j4-dmenu-desktop.md#void-packages-structure)). The
119+
[j4-dmenu-desktop](xbps-src-tutorial/packaging-j4-dmenu-desktop.md#void-packages-structure)). The
120120
following instructions can be easily changed to fit other architectures as well.
121121
For example if you are on `musl`, you won't have to create a special builddir
122122
for `x86_64-musl` because that is your default builddir.
@@ -435,7 +435,7 @@ _If you're on `x86_64`, this method is recommended only for `i686` and `x86_64-m
435435

436436
### Running compiled programs inside `masterdir` (QEMU build helper) { #qemu }
437437
As I've mentioned in [Packaging
438-
j4-dmenu-desktop](packaging-j4-dmenu-desktop.md#what-is-cross-compilation), you
438+
j4-dmenu-desktop](xbps-src-tutorial/packaging-j4-dmenu-desktop.md#what-is-cross-compilation), you
439439
can't run compiled executables when building a template under normal conditions.
440440

441441
_This applies only for **cross compilation**, not for [native compilation for
@@ -472,7 +472,7 @@ hungry.
472472
If upstream's build system wants to execute things (and it isn't `cmake` nor
473473
`meson`[^badqemu]), you will have to convince it to use QEMU. You'll probably
474474
have to [make patches to the build
475-
system](packaging-j4-dmenu-desktop.md#when-their-build-system-is-broken). This
475+
system](xbps-src-tutorial/packaging-j4-dmenu-desktop.md#when-their-build-system-is-broken). This
476476
can be difficult
477477
sometimes. You should consider [notifying upstream about
478478
it](troubleshooting.md#notifying-upstream).

src/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ way of communication could be a mailing list, there might simply not be any way
180180
to contact the maintainers and more.
181181

182182
## Failing checks
183-
See [contributing](contributing.md#solving-check-errors).
183+
See [contributing](xbps-src-tutorial/contributing.md#solving-check-errors).
184184

185185
## Other problems
186186
### Builds use only a single thread

src/xbps-src-tutorial/contributing.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,30 +70,30 @@ account](https://docs.github.com/en/account-and-profile/setting-up-and-managing-
7070

7171
This is what a good commit looks like:
7272

73-
![good commit](images/contributing/good_commit.png)
73+
![good commit](../images/contributing/good_commit.png)
7474

7575
When you'll hover over it, you'll see a popup:
7676

77-
![good commit popup](images/contributing/good_commit_popup.png)
77+
![good commit popup](../images/contributing/good_commit_popup.png)
7878

7979
This is how a bad commit looks like:
8080

81-
![bad commit](images/contributing/bad_commit.png)
81+
![bad commit](../images/contributing/bad_commit.png)
8282

8383
When you hover over it, nothing happens.
8484

8585
Here are some funny examples of bad commits:
8686

87-
![funny commit](images/contributing/meator_with_meator.png)
87+
![funny commit](../images/contributing/meator_with_meator.png)
8888

89-
![funny commit closeup](images/contributing/meator_with_meator_detailed.png)
89+
![funny commit closeup](../images/contributing/meator_with_meator_detailed.png)
9090

9191
Here I have collaborated with myself apparently. This can happen when your
9292
author string doesn't match your `user.name` and `user.email`.
9393

9494
## Things to check
9595
[You should ensure that the repo is up to
96-
date.](troubleshooting.md#being-up-to-date)
96+
date.](../troubleshooting.md#being-up-to-date)
9797

9898
You should also make sure that no `xlint` errors are in the templates you want
9999
to contribute.
@@ -118,7 +118,7 @@ git checkout upstream/master -b <a-descriptive-name>
118118
```
119119
120120
to really make sure the branch is [up to
121-
date](troubleshooting.md#being-up-to-date).[^uptodate]
121+
date](../troubleshooting.md#being-up-to-date).[^uptodate]
122122
123123
## Making the commits
124124
The most important requirement (apart from quality requirements) are commit
@@ -207,10 +207,10 @@ using different architectures and libcs.
207207

208208
Here is an example of a failed check:
209209

210-
![failed check](images/contributing/failed_check.png)
210+
![failed check](../images/contributing/failed_check.png)
211211

212212
You can click on Details to see what `xbps-src` outputted. [It is also useful to
213-
reproduce the error locally.](tips_and_tricks.md#reproduce-checks-locally)
213+
reproduce the error locally.](../tips_and_tricks.md#reproduce-checks-locally)
214214

215215
You should try to fix these errors. Cross compilation is the source of most
216216
problems when contributing new packages. This is briefly described in [Packaging
@@ -422,12 +422,12 @@ You can then follow the link provided by git to create the pull request.
422422

423423
## That's all folks!
424424
This is the end of xbps-src packaging tutorial. Thank you for taking the time to
425-
read this tutorial! Feel free to share your [feedback](feedback.md) if you'd
425+
read this tutorial! Feel free to share your [feedback](../feedback.md) if you'd
426426
like to.
427427

428428
If you want to continue reading, you can look at
429-
[troubleshooting](troubleshooting.md) and [tips and tricks](tips_and_tricks.md)
430-
for more useful info about `xbps-src`.
429+
[troubleshooting](../troubleshooting.md) and [tips and
430+
tricks](../tips_and_tricks.md) for more useful info about `xbps-src`.
431431

432432
---
433433

src/xbps-src-tutorial/packaging-bat.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ of it is in their repository: <https://github.com/sharkdp/bat>
2020
- `short_desc`: `Cat(1) clone with syntax highlighting and Git integration`
2121
- `license`: `bat` has two licenses, `Apache-2.0` and `MIT`:
2222

23-
![license](images/bat/license.png)
23+
![license](../images/bat/license.png)
2424

2525
Multiple licenses should be separated by ", " like this:
2626
```
@@ -42,7 +42,7 @@ of it is in their repository: <https://github.com/sharkdp/bat>
4242

4343
- `distfiles`: `bat`'s release has a lot of files in it:
4444

45-
![bat release](images/bat/release.png)
45+
![bat release](../images/bat/release.png)
4646

4747
Prebuilt archives can not be used in
4848
[`void-packages`](https://github.com/void-linux/void-packages). So you must
@@ -290,7 +290,7 @@ post_install() {
290290
}
291291
```
292292

293-
[This is an useful trick by the way.](tips_and_tricks.md#setting-environmental-variables)
293+
[This is an useful trick by the way.](../tips_and_tricks.md#setting-environmental-variables)
294294

295295
`BAT_ASSETS_GEN_DIR` uses `XBPS_BUILDDIR`, `pkgname` and `version` variables.
296296
`pkgname` and `version` are defined in the template and `XBPS_BUILDDIR` is an

0 commit comments

Comments
 (0)