Skip to content

Commit 5754080

Browse files
authored
Fix various typos of software names (#18083)
* `git` -> `Git` * `Github` and `github` -> `GitHub` * `crowdin` -> `Crowdin` * `git-lfs` -> `Git LFS` * `githooks`, `git hooks`, `git-hooks` -> `Git Hooks` * `discord` -> `Discord` * `2fa` -> `2FA` * `gitlab` and `Gitlab` -> `GitLab` * `web hook` -> `webhook` * `linux` -> `Linux` * `sqlite` -> `SQLite` * `MYSQL` and `mysql` -> `MySQL` * rename refs to `master` branch -> `main` * Fix English grammar
1 parent a5df7ba commit 5754080

28 files changed

+92
-92
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Please check the following:
44
55
1. Make sure you are targeting the `main` branch, pull requests on release branches are only allowed for bug fixes.
6-
2. Read contributing guidelines: https://github.com/go-gitea/gitea/blob/master/CONTRIBUTING.md
6+
2. Read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md
77
3. Describe what your pull request does and which issue you're targeting (if any)
88
99
-->

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ Here's how to run the test suite:
8181
|``make lint-frontend`` | lint frontend files |
8282
|``make lint-backend`` | lint backend files |
8383

84-
- run test code (Suggest run in linux)
84+
- run test code (Suggest run in Linux)
8585

8686
| | |
8787
| :------------------------------------- | :----------------------------------------------- |
8888
|``make test[\#TestSpecificName]`` | run unit test |
89-
|``make test-sqlite[\#TestSpecificName]``| run [integration](integrations) test for sqlite |
90-
|[More detail message about integrations](integrations/README.md) |
89+
|``make test-sqlite[\#TestSpecificName]``| run [integration](integrations) test for SQLite |
90+
|[More details about integrations](integrations/README.md) |
9191

9292
## Vendoring
9393

@@ -106,7 +106,7 @@ You can find more information on how to get started with it on the [Modules Wiki
106106
## Translation
107107

108108
We do all translation work inside [Crowdin](https://crowdin.com/project/gitea).
109-
The only translation that is maintained in this git repository is
109+
The only translation that is maintained in this Git repository is
110110
[`en_US.ini`](https://github.com/go-gitea/gitea/blob/master/options/locale/locale_en-US.ini)
111111
and is synced regularly to Crowdin. Once a translation has reached
112112
A SATISFACTORY PERCENTAGE it will be synced back into this repo and
@@ -157,7 +157,7 @@ import (
157157

158158
## Design guideline
159159

160-
To maintain understandable code and avoid circular dependencies it is important to have a good structure of the code. The gitea code is divided into the following parts:
160+
To maintain understandable code and avoid circular dependencies it is important to have a good structure of the code. The Gitea code is divided into the following parts:
161161

162162
- **integration:** Integrations tests
163163
- **models:** Contains the data structures used by xorm to construct database tables. It also contains supporting functions to query and update the database. Dependencies to other code in Gitea should be avoided although some modules might be needed (for example for logging).
@@ -223,7 +223,7 @@ Additionally you could add a line at the end of your commit message.
223223
Signed-off-by: Joe Smith <[email protected]>
224224
```
225225

226-
If you set your `user.name` and `user.email` git configs, you can add the
226+
If you set your `user.name` and `user.email` Git configs, you can add the
227227
line to the end of your commit automatically with `git commit -s`.
228228

229229
We assume in good faith that the information you provide is legally binding.
@@ -268,7 +268,7 @@ to the maintainers team. If a maintainer is inactive for more than 3
268268
months and forgets to leave the maintainers team, the owners may move
269269
him or her from the maintainers team to the advisors team.
270270
For security reasons, Maintainers should use 2FA for their accounts and
271-
if possible provide gpg signed commits.
271+
if possible provide GPG signed commits.
272272
https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/
273273
https://help.github.com/articles/signing-commits-with-gpg/
274274

@@ -326,28 +326,28 @@ they served:
326326

327327
## Versions
328328

329-
Gitea has the `master` branch as a tip branch and has version branches
329+
Gitea has the `main` branch as a tip branch and has version branches
330330
such as `release/v0.9`. `release/v0.9` is a release branch and we will
331331
tag `v0.9.0` for binary download. If `v0.9.0` has bugs, we will accept
332332
pull requests on the `release/v0.9` branch and publish a `v0.9.1` tag,
333-
after bringing the bug fix also to the master branch.
333+
after bringing the bug fix also to the main branch.
334334

335-
Since the `master` branch is a tip version, if you wish to use Gitea
335+
Since the `main` branch is a tip version, if you wish to use Gitea
336336
in production, please download the latest release tag version. All the
337337
branches will be protected via GitHub, all the PRs to every branch must
338338
be reviewed by two maintainers and must pass the automatic tests.
339339

340340
## Releasing Gitea
341341

342342
* Let $vmaj, $vmin and $vpat be Major, Minor and Patch version numbers, $vpat should be rc1, rc2, 0, 1, ...... $vmaj.$vmin will be kept the same as milestones on github or gitea in future.
343-
* Before releasing, confirm all the version's milestone issues or PRs has been resolved. Then discuss the release on discord channel #maintainers and get agreed with almost all the owners and mergers. Or you can declare the version and if nobody against in about serval hours.
344-
* If this is a big version first you have to create PR for changelog on branch `master` with PRs with label `changelog` and after it has been merged do following steps:
343+
* Before releasing, confirm all the version's milestone issues or PRs has been resolved. Then discuss the release on Discord channel #maintainers and get agreed with almost all the owners and mergers. Or you can declare the version and if nobody against in about serval hours.
344+
* If this is a big version first you have to create PR for changelog on branch `main` with PRs with label `changelog` and after it has been merged do following steps:
345345
* Create `-dev` tag as `git tag -s -F release.notes v$vmaj.$vmin.0-dev` and push the tag as `git push origin v$vmaj.$vmin.0-dev`.
346346
* When CI has finished building tag then you have to create a new branch named `release/v$vmaj.$vmin`
347347
* If it is bugfix version create PR for changelog on branch `release/v$vmaj.$vmin` and wait till it is reviewed and merged.
348348
* Add a tag as `git tag -s -F release.notes v$vmaj.$vmin.$`, release.notes file could be a temporary file to only include the changelog this version which you added to `CHANGELOG.md`.
349-
* And then push the tag as `git push origin v$vmaj.$vmin.$`. Drone CI will automatically created a release and upload all the compiled binary. (But currently it didn't add the release notes automatically. Maybe we should fix that.)
350-
* If needed send PR for changelog on branch `master`.
349+
* And then push the tag as `git push origin v$vmaj.$vmin.$`. Drone CI will automatically create a release and upload all the compiled binary. (But currently it doesn't add the release notes automatically. Maybe we should fix that.)
350+
* If needed send PR for changelog on branch `main`.
351351
* Send PR to [blog repository](https://gitea.com/gitea/blog) announcing the release.
352352

353353
## Copyright

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ From the root of the source tree, run:
6767

6868
TAGS="bindata" make build
6969

70-
or if sqlite support is required:
70+
or if SQLite support is required:
7171

7272
TAGS="bindata sqlite sqlite_unlock_notify" make build
7373

docs/content/doc/advanced/adding-legal-pages.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Poli
2020
Gitea source code ships with sample pages, available in `contrib/legal` directory. Copy them to `custom/public/`. For example, to add Privacy Policy:
2121

2222
```
23-
wget -O /path/to/custom/public/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/master/contrib/legal/privacy.html.sample
23+
wget -O /path/to/custom/public/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/legal/privacy.html.sample
2424
```
2525

2626
Now you need to edit the page to meet your requirements. In particular you must change the email addresses, web addresses and references to "Your Gitea Instance" to match your situation.

docs/content/doc/advanced/clone-filter.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ git config --global uploadpack.allowfilter true
6060

6161
See [GitHub blog post: Get up to speed with partial clone](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/)
6262
for common use cases of clone filters (blobless and treeless clones), and
63-
[Gitlab docs for partial clone](https://docs.gitlab.com/ee/topics/git/partial_clone.html)
63+
[GitLab docs for partial clone](https://docs.gitlab.com/ee/topics/git/partial_clone.html)
6464
for more advanced use cases (such as filter by file size and remove
6565
filters to turn partial clone into full clone).

docs/content/doc/advanced/cmd-embedded.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The default is the current directory.
8585
The `--custom` flag tells Gitea to extract the files directly into the `custom` directory.
8686
For this to work, the command needs to know the location of the `app.ini` configuration
8787
file (`--config`) and, depending of the configuration, be ran from the directory where
88-
gitea normally starts. See [Customizing Gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}) for details.
88+
Gitea normally starts. See [Customizing Gitea]({{< relref "doc/advanced/customizing-gitea.en-us.md" >}}) for details.
8989

9090
The `--overwrite` flag allows any existing files in the destination directory to be overwritten.
9191

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
302302
- `PPROF_DATA_PATH`: **data/tmp/pprof**: `PPROF_DATA_PATH`, use an absolute path when you start Gitea as service
303303
- `LANDING_PAGE`: **home**: Landing page for unauthenticated users \[home, explore, organizations, login\].
304304

305-
- `LFS_START_SERVER`: **false**: Enables git-lfs support.
305+
- `LFS_START_SERVER`: **false**: Enables Git LFS support.
306306
- `LFS_CONTENT_PATH`: **%(APP_DATA_PATH)/lfs**: Default LFS content path. (if it is on local storage.) **DEPRECATED** use settings in `[lfs]`.
307307
- `LFS_JWT_SECRET`: **\<empty\>**: LFS authentication secret, change this a unique string.
308308
- `LFS_HTTP_AUTH_EXPIRY`: **20m**: LFS authentication validity period in time.Duration, pushes taking longer than this may fail.
@@ -378,7 +378,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
378378
- `require`: Enable TLS without any verifications.
379379
- `verify-ca`: Enable TLS with verification of the database server certificate against its root certificate.
380380
- `verify-full`: Enable TLS and verify the database server name matches the given certificate in either the `Common Name` or `Subject Alternative Name` fields.
381-
- `SQLITE_TIMEOUT`: **500**: Query timeout for sqlite3 only.
381+
- `SQLITE_TIMEOUT`: **500**: Query timeout for SQLite3 only.
382382
- `ITERATE_BUFFER_SIZE`: **50**: Internal buffer size for iterating.
383383
- `CHARSET`: **utf8mb4**: For MySQL only, either "utf8" or "utf8mb4". NOTICE: for "utf8mb4" you must use MySQL InnoDB > 5.6. Gitea is unable to check this.
384384
- `PATH`: **data/gitea.db**: For SQLite3 only, the database file path.
@@ -490,8 +490,8 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
490490
- `REVERSE_PROXY_LIMIT`: **1**: Interpret X-Forwarded-For header or the X-Real-IP header and set this as the remote IP for the request.
491491
Number of trusted proxy count. Set to zero to not use these headers.
492492
- `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: List of IP addresses and networks separated by comma of trusted proxy servers. Use `*` to trust all.
493-
- `DISABLE_GIT_HOOKS`: **true**: Set to `false` to enable users with git hook privilege to create custom git hooks.
494-
WARNING: Custom git hooks can be used to perform arbitrary code execution on the host operating system.
493+
- `DISABLE_GIT_HOOKS`: **true**: Set to `false` to enable users with Git Hook privilege to create custom Git Hooks.
494+
WARNING: Custom Git Hooks can be used to perform arbitrary code execution on the host operating system.
495495
This enables the users to access and modify this config file and the Gitea database and interrupt the Gitea service.
496496
By modifying the Gitea database, users can gain Gitea administrator privileges.
497497
It also enables them to access other resources available to the user on the operating system that is running the
@@ -595,7 +595,7 @@ Certain queues have defaults that override the defaults set in `[queue]` (this o
595595
- `DEFAULT_ORG_MEMBER_VISIBLE`: **false** True will make the membership of the users visible when added to the organisation.
596596
- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false** Set to true to force registration only via Gitea.
597597
- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false** Set to true to force registration only using third-party services.
598-
- `NO_REPLY_ADDRESS`: **noreply.DOMAIN** Value for the domain part of the user's email address in the git log if user has set KeepEmailPrivate to true. DOMAIN resolves to the value in server.DOMAIN.
598+
- `NO_REPLY_ADDRESS`: **noreply.DOMAIN** Value for the domain part of the user's email address in the Git log if user has set KeepEmailPrivate to true. DOMAIN resolves to the value in server.DOMAIN.
599599
The user's email will be replaced with a concatenation of the user name in lower case, "@" and NO_REPLY_ADDRESS.
600600
- `USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0** Minimum amount of time a user must exist before comments are kept when the user is deleted.
601601
- `VALID_SITE_URL_SCHEMES`: **http, https**: Valid site url schemes for user profiles
@@ -658,7 +658,7 @@ Define allowed algorithms and their minimum key length (use -1 to disable a type
658658
- `MAILER_TYPE`: **smtp**: \[smtp, sendmail, dummy\]
659659
- **smtp** Use SMTP to send mail
660660
- **sendmail** Use the operating system's `sendmail` command instead of SMTP.
661-
This is common on linux systems.
661+
This is common on Linux systems.
662662
- **dummy** Send email messages to the log as a testing phase.
663663
- Note that enabling sendmail will ignore all other `mailer` settings except `ENABLED`,
664664
`FROM`, `SUBJECT_PREFIX` and `SENDMAIL_PATH`.
@@ -918,15 +918,15 @@ NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take ef
918918

919919
## Git (`git`)
920920

921-
- `PATH`: **""**: The path of git executable. If empty, Gitea searches through the PATH environment.
921+
- `PATH`: **""**: The path of Git executable. If empty, Gitea searches through the PATH environment.
922922
- `DISABLE_DIFF_HIGHLIGHT`: **false**: Disables highlight of added and removed changes.
923923
- `MAX_GIT_DIFF_LINES`: **1000**: Max number of lines allowed of a single file in diff view.
924924
- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: Max character count per line highlighted in diff view.
925925
- `MAX_GIT_DIFF_FILES`: **100**: Max number of files shown in diff view.
926926
- `COMMITS_RANGE_SIZE`: **50**: Set the default commits range size
927927
- `BRANCHES_RANGE_SIZE`: **20**: Set the default branches range size
928928
- `GC_ARGS`: **\<empty\>**: Arguments for command `git gc`, e.g. `--aggressive --auto`. See more on http://git-scm.com/docs/git-gc/
929-
- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: If use git wire protocol version 2 when git version >= 2.18, default is true, set to false when you always want git wire protocol version 1
929+
- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: If use Git wire protocol version 2 when Git version >= 2.18, default is true, set to false when you always want Git wire protocol version 1
930930
- `PULL_REQUEST_PUSH_MESSAGE`: **true**: Respond to pushes to a non-default branch with a URL for creating a Pull Request (if the repository has them enabled)
931931
- `VERBOSE_PUSH`: **true**: Print status information about pushes as they are being processed.
932932
- `VERBOSE_PUSH_DELAY`: **5s**: Only print verbose information if push takes longer than this delay.
@@ -952,7 +952,7 @@ NB: You must have `DISABLE_ROUTER_LOG` set to `false` for this option to take ef
952952
- `ENABLE_SWAGGER`: **true**: Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true.
953953
- `MAX_RESPONSE_ITEMS`: **50**: Max number of items in a page.
954954
- `DEFAULT_PAGING_NUM`: **30**: Default paging number of API.
955-
- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Default and maximum number of items per page for git trees API.
955+
- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Default and maximum number of items per page for Git trees API.
956956
- `DEFAULT_MAX_BLOB_SIZE`: **10485760**: Default max size of a blob that can be return by the blobs API.
957957

958958
## OAuth2 (`oauth2`)

docs/content/doc/advanced/customizing-gitea.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ To add a custom license, add a file with the license text to `$GITEA_CUSTOM/opti
287287

288288
### Locales
289289

290-
Locales are managed via our [crowdin](https://crowdin.com/project/gitea).
290+
Locales are managed via our [Crowdin](https://crowdin.com/project/gitea).
291291
You can override a locale by placing an altered locale file in `$GITEA_CUSTOM/options/locale`.
292292
Gitea's default locale files can be found in the [`options/locale`](https://github.com/go-gitea/gitea/tree/main/options/locale) source folder and these should be used as examples for your changes.
293293

docs/content/doc/advanced/protected-tags.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ menu:
1515

1616
# Protected tags
1717

18-
Protected tags allow control over who has permission to create or update git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once.
18+
Protected tags allow control over who has permission to create or update Git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once.
1919

2020
**Table of Contents**
2121

docs/content/doc/advanced/signing.en-us.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ menu:
2121

2222
Gitea will verify GPG commit signatures in the provided tree by
2323
checking if the commits are signed by a key within the Gitea database,
24-
or if the commit matches the default key for git.
24+
or if the commit matches the default key for Git.
2525

2626
Keys are not checked to determine if they have expired or revoked.
2727
Keys are also not checked with keyservers.
@@ -33,8 +33,8 @@ it is reported to be signed with a key with an id.
3333
Please note: The signer of a commit does not have to be an author or
3434
committer of a commit.
3535

36-
This functionality requires git >= 1.7.9 but for full functionality
37-
this requires git >= 2.0.0.
36+
This functionality requires Git >= 1.7.9 but for full functionality
37+
this requires Git >= 2.0.0.
3838

3939
## Automatic Signing
4040

@@ -54,7 +54,7 @@ It is up to a server administrator to determine how best to install
5454
a signing key. Gitea generates all its commits using the server `git`
5555
command at present - and therefore the server `gpg` will be used for
5656
signing (if configured.) Administrators should review best-practices
57-
for gpg - in particular it is probably advisable to only install a
57+
for GPG - in particular it is probably advisable to only install a
5858
signing secret subkey without the master signing and certifying secret
5959
key.
6060

@@ -93,7 +93,7 @@ The `default` option will interrogate `git config` for
9393
`commit.gpgsign` option - if this is set, then it will use the results
9494
of the `user.signingkey`, `user.name` and `user.email` as appropriate.
9595

96-
Please note: by adjusting git's `config` file within Gitea's
96+
Please note: by adjusting Git's `config` file within Gitea's
9797
repositories, `SIGNING_KEY=default` could be used to provide different
9898
signing keys on a per-repository basis. However, this is clearly not an
9999
ideal UI and therefore subject to change.

docs/content/doc/developers/api-usage.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ the `token=` string in a GET request.
110110
111111
API Reference guide is auto-generated by swagger and available on:
112112
`https://gitea.your.host/api/swagger`
113-
or on
114-
[gitea demo instance](https://try.gitea.io/api/swagger)
113+
or on the
114+
[Gitea demo instance](https://try.gitea.io/api/swagger)
115115
116116
The OpenAPI document is at:
117117
`https://gitea.your.host/swagger.v1.json`

docs/content/doc/developers/guidelines-backend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ So it's very important to manage these packages. Please take the below guideline
3232
To maintain understandable code and avoid circular dependencies it is important to have a good code structure. The Gitea backend is divided into the following parts:
3333

3434
- `build`: Scripts to help build Gitea.
35-
- `cmd`: All Gitea actual sub commands includes web, doctor, serv, hooks, admin and etc. `web` will start the web service. `serv` and `hooks` will be invoked by git or openSSH. Other sub commands could help to maintain Gitea.
35+
- `cmd`: All Gitea actual sub commands includes web, doctor, serv, hooks, admin and etc. `web` will start the web service. `serv` and `hooks` will be invoked by Git or OpenSSH. Other sub commands could help to maintain Gitea.
3636
- `integrations`: Integration tests
3737
- `models`: Contains the data structures used by xorm to construct database tables. It also contains functions to query and update the database. Dependencies to other Gitea code should be avoided. You can make exceptions in cases such as logging.
3838
- `models/db`: Basic database operations. All other `models/xxx` packages should depend on this package. The `GetEngine` function should only be invoked from `models/`.

0 commit comments

Comments
 (0)