Skip to content

Commit 64ff0a7

Browse files
committed
doc: Update gitoxide repository URLs
This updates `Byron/gitoxide` URLs to `GitoxideLabs/gitoxide` in: - Markdown documentation, except changelogs and other such files where such changes should not be made. - Documentation comments (in .rs files). - Manifest (.toml) files, for the value of the `repository` key. - The comments appearing at the top of a sample hook that contains a repository URL as an example. When making these changes, I also allowed my editor to remove trailing whitespace in any lines in files already being edited (since, in this case, there was no disadvantage to allowing this). The gitoxide repository URL changed when the repository was moved into the recently created GitHub organization `GitoxideLabs`, as detailed in #1406. Please note that, although I believe updating the URLs to their new canonical values is useful, this is not needed to fix any broken links, since `Byron/gitoxide` URLs redirect (and hopefully will always redirect) to the coresponding `GitoxideLabs/gitoxide` URLs. While this change should not break any URLs, some affected URLs were already broken. This updates them, but they are still broken. They will be fixed in a subsequent commit. This also does not update `Byron/gitoxide` URLs in test fixtures or test cases, nor in the `Makefile`. (It may make sense to change some of those too, but it is not really a documentation change.)
1 parent 70c4df5 commit 64ff0a7

File tree

95 files changed

+273
-274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+273
-274
lines changed

COLLABORATING.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- If you're unsure about remembering to do this, we suggest using a pre-commit git hook.
1515
- **if `main` breaks on CI** _which can happen nonetheless_
1616
- …and you _do know_ the cause, please fix it immediately. If necessary by reverting the offending commit until a more durable fix is possible.
17-
- …and you _do not know_ the cause, please open a PR to invite collaborators for their input. This is to avoid multiple collaborators
17+
- …and you _do not know_ the cause, please open a PR to invite collaborators for their input. This is to avoid multiple collaborators
1818
trying to fix the issue independently, causing merge-conflicts and confusion. We use this PR as synchronization primitive.
1919
- **for crates _you own_**
2020
- feel free to make any kind of changes to it, including major ones.
@@ -29,7 +29,6 @@ The workflow can be changed after public discussion - to get started, open a PR.
2929

3030
Please see the [development guide] for more detailed information on how code and cargo manifests are structured.
3131

32-
[development guide]: https://github.com/Byron/gitoxide/blob/main/DEVELOPMENT.md
33-
[project-board]: https://github.com/Byron/gitoxide/projects
34-
[discussions]: https://github.com/Byron/gitoxide/discussions
35-
32+
[development guide]: https://github.com/GitoxideLabs/gitoxide/blob/main/DEVELOPMENT.md
33+
[project-board]: https://github.com/GitoxideLabs/gitoxide/projects
34+
[discussions]: https://github.com/GitoxideLabs/gitoxide/discussions

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
For now, please have a look at the section in the [README] file.
22

3-
[README]: https://github.com/Byron/gitoxide#contributions
3+
[README]: https://github.com/GitoxideLabs/gitoxide#contributions

Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ lints.workspace = true
33
[package]
44
name = "gitoxide"
55
description = "A command-line application for interacting with git repositories"
6-
repository = "https://github.com/Byron/gitoxide"
6+
repository = "https://github.com/GitoxideLabs/gitoxide"
77
authors = ["Sebastian Thiel <[email protected]>"]
88
edition = "2021"
99
license = "MIT OR Apache-2.0"
@@ -392,4 +392,4 @@ unnecessary_join = "allow" # x1
392392
stable_sort_primitive = "allow" # x1
393393
no_effect_underscore_binding = "allow" # x1
394394
empty_docs = "allow"
395-
too_long_first_doc_paragraph = "allow"
395+
too_long_first_doc_paragraph = "allow"

DEVELOPMENT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* handle all errors, never `unwrap()`. If needed, `expect("why")`.
1717
* provide an error chain and make it easy to understand what went wrong.
1818
* We `thiserror` generally.
19-
* Adhere to the [stability guide](https://github.com/Byron/gitoxide/blob/main/STABILITY.md)
19+
* Adhere to the [stability guide](https://github.com/GitoxideLabs/gitoxide/blob/main/STABILITY.md)
2020

2121
## Commit Messages
2222

@@ -196,7 +196,7 @@ In _porcelain_ crates, like `gix`, we have `Platforms` which are typically cheap
196196
should keep a reference to the `Repository` instance that created them as the user is expected to clone the `Repository` if there is the need.
197197
However, if these structures are more expensive, call them `Cache` or `<NotPlatform>` and prefer to clone the `Repository` into them or otherwise keep them free of lifetimes
198198
to allow the user to keep this structure around for repeated calls. References for this paragraph are [this PR](https://github.com/Canop/bacon/pull/98) and
199-
[this discussion](https://github.com/Byron/gitoxide/discussions/675).
199+
[this discussion](https://github.com/GitoxideLabs/gitoxide/discussions/675).
200200

201201
## Examples, Porcelain CLI and Plumbing CLI - which does what?
202202

README.md

+84-84
Large diffs are not rendered by default.

SECURITY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Reporting a Vulnerability
44

5-
Please feel free to [draft a GitHub advisory](https://github.com/Byron/gitoxide/security/advisories/new), and I will work with you to disclose and or resolve the issue
5+
Please feel free to [draft a GitHub advisory](https://github.com/GitoxideLabs/gitoxide/security/advisories/new), and I will work with you to disclose and or resolve the issue
66
responsibly.
77

8-
If this doesn't seem like the right approach or there are questions, please feel free to reach out to the @icloud.com email used in my commits.
8+
If this doesn't seem like the right approach or there are questions, please feel free to reach out to the @icloud.com email used in my commits.
99

1010
Thank you.

SHORTCOMINGS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This file is for tracking features that are less well implemented or less powerf
2525
* **Objects larger than 32 bits cannot be loaded on 32 bit systems**
2626
* in-memory representations objects cannot handle objects greater than the amount of addressable memory.
2727
* This will not affect git LFS though.
28-
28+
2929
### `gix`
3030

3131
* object replacements are read once upon opening the repository from their refs and changes to these won't be picked up.
@@ -38,5 +38,5 @@ This file is for tracking features that are less well implemented or less powerf
3838

3939
### `gix-features`
4040

41-
* **sha1** isn't hardened (i.e. doesn't have collision detection). Needs [to be contributed](https://github.com/Byron/gitoxide/issues/585).
41+
* **sha1** isn't hardened (i.e. doesn't have collision detection). Needs [to be contributed](https://github.com/GitoxideLabs/gitoxide/issues/585).
4242
* **local time** is currently impeded by [this issue](https://github.com/time-rs/time/issues/293#issuecomment-909158529) but it's planned to resolve it eventually.

STABILITY.md

+36-36
Original file line numberDiff line numberDiff line change
@@ -34,55 +34,55 @@ our [collaboration guide].
3434
The following schematic helps to visualize what follows.
3535

3636
```text
37-
Release Software v1.X
38-
Stability Tier 1 ═════════════════════════════╗
39-
║ ║
40-
║ gix──────────────┐ ein──────────────┐ ║
41-
║ │ plumbing app │ │ porcelain app │ ║
42-
║ └────────────────┘ └────────────────┘ ║
43-
║ │ │ ║
44-
║ ▼ ▼ ║
45-
║ gitoxide-core───────────────────────┐ ║
46-
║ │ application functionality │ ║
47-
║ └───────────────────────────────────┘ ║
48-
║ │ ║
49-
║ ▼ ║
50-
║ gix ──────────────────────────────┐ ║
51-
║ │ application crate │─ ─ ╬ ─
37+
Release Software v1.X
38+
Stability Tier 1 ═════════════════════════════╗
39+
║ ║
40+
║ gix──────────────┐ ein──────────────┐ ║
41+
║ │ plumbing app │ │ porcelain app │ ║
42+
║ └────────────────┘ └────────────────┘ ║
43+
║ │ │ ║
44+
║ ▼ ▼ ║
45+
║ gitoxide-core───────────────────────┐ ║
46+
║ │ application functionality │ ║
47+
║ └───────────────────────────────────┘ ║
48+
║ │ ║
49+
║ ▼ ║
50+
║ gix ──────────────────────────────┐ ║
51+
║ │ application crate │─ ─ ╬ ─
5252
║ └───────────────────────────────────┘ ║ │
53-
║ │ ║
53+
║ │ ║
5454
║ ▼ ║ │
55-
║ Foundation Crates───────────────────┐ ║
55+
║ Foundation Crates───────────────────┐ ║
5656
║ │ ┌─────────────┐ ┌─────────────┐ │ ║ │
57-
║ │ │ gix-hash │ │ gix-actor │ │ ║
57+
║ │ │ gix-hash │ │ gix-actor │ │ ║
5858
║ │ └─────────────┘ └─────────────┘ │ ║ │
59-
║ │ ┌─────────────┐ ┌─────────────┐ │ ║
59+
║ │ ┌─────────────┐ ┌─────────────┐ │ ║
6060
║ │ │ gix-ref │ │ gix-config │ │ ║ │
61-
║ │ └─────────────┘ └─────────────┘ │ ║
61+
║ │ └─────────────┘ └─────────────┘ │ ║
6262
║ │ ┌─────────────┐ ┌─────────────┐ │ ║ │
63-
║ │ │ gix-object │ │ gix-lock │ │ ║
63+
║ │ │ gix-object │ │ gix-lock │ │ ║
6464
║ │ └─────────────┘ └─────────────┘ │ ║ │
65-
║ │ ┌───────────────────────────────┐ │ ║
65+
║ │ ┌───────────────────────────────┐ │ ║
6666
║ │ │ gix-features │ │ ║ │
67-
║ │ └───────────────────────────────┘ │ ║
67+
║ │ └───────────────────────────────┘ │ ║
6868
║ └───────────────────────────────────┘ ║ │
69-
║ ║
69+
║ ║
7070
╚═════════════════════════════════════════════╝ │
71-
71+
7272
Stability Tier 2 ─────────────────────────────┐ │
73-
│ │
73+
│ │
7474
│ Plumbing Crates─────────────────────┐ │ │
75-
│ │ ┌─────────────┐ ┌─────────────┐ │ │
75+
│ │ ┌─────────────┐ ┌─────────────┐ │ │
7676
│ │ │ gix-odb │ │ gix-diff │ │ │ │
77-
│ │ └─────────────┘ └─────────────┘ │ │
77+
│ │ └─────────────┘ └─────────────┘ │ │
7878
│ │ ┌─────────────┐ ┌─────────────┐ │ │ │
79-
│ │ │gix-traverse │ │ gix-pack │ │◀ ─ ┼ ─
80-
│ │ └─────────────┘ └─────────────┘ │ │
81-
│ │ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ │ │
82-
│ │ …many more… │ │
83-
│ │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ │ │
84-
│ └───────────────────────────────────┘ │
85-
│ │
79+
│ │ │gix-traverse │ │ gix-pack │ │◀ ─ ┼ ─
80+
│ │ └─────────────┘ └─────────────┘ │ │
81+
│ │ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ │ │
82+
│ │ …many more… │ │
83+
│ │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ │ │
84+
│ └───────────────────────────────────┘ │
85+
│ │
8686
└─────────────────────────────────────────────┘
8787
```
8888

@@ -151,4 +151,4 @@ Apps and application crates may take longer as they are larger in scope. A good
151151
use. Their scope should also be narrowed to a minimal viable product.
152152

153153
[semver]: https://semver.org
154-
[collaboration guide]: https://github.com/Byron/gitoxide/blob/main/COLLABORATING.md
154+
[collaboration guide]: https://github.com/GitoxideLabs/gitoxide/blob/main/COLLABORATING.md

0 commit comments

Comments
 (0)