diff options
author | Nasser Grainawi <nasser.grainawi@linaro.org> | 2023-04-05 15:54:15 +0000 |
---|---|---|
committer | Gerrit Code Review <noreply-gerritcodereview@google.com> | 2023-04-05 15:54:15 +0000 |
commit | e62dc9d4219baeb9496bb536ae536a019daa74c9 (patch) | |
tree | 1d3ae0d3d3d0e40945579bc8e32e2505fc14047e | |
parent | 8308428d87bacbe43bf8eaab505543a40340c259 (diff) | |
parent | 6b67d57cd7c45019e962ca350311ca5f8468132b (diff) |
Merge "Fix minor typos in several dev-*.txt docs" into stable-3.8
-rw-r--r-- | Documentation/dev-bazel.txt | 4 | ||||
-rw-r--r-- | Documentation/dev-crafting-changes.txt | 2 | ||||
-rw-r--r-- | Documentation/dev-design.txt | 4 | ||||
-rw-r--r-- | Documentation/dev-eclipse.txt | 7 | ||||
-rw-r--r-- | Documentation/dev-intellij.txt | 4 | ||||
-rw-r--r-- | Documentation/dev-plugins.txt | 6 | ||||
-rw-r--r-- | Documentation/dev-readme.txt | 2 |
7 files changed, 15 insertions, 14 deletions
diff --git a/Documentation/dev-bazel.txt b/Documentation/dev-bazel.txt index d1a5bcf23f..514a4c9418 100644 --- a/Documentation/dev-bazel.txt +++ b/Documentation/dev-bazel.txt @@ -352,7 +352,7 @@ Example: ---- Now attach with a debugger to the port `5005`. For example use "Remote Java Application" launch -configuration in Eclipe and specify the port `5005`. +configuration in Eclipse and specify the port `5005`. [[logging]] === Controlling logging level @@ -551,7 +551,7 @@ bazel run @nodejs//:yarn add $package ---- Update the `polygerrit-ui/app/node_modules_licenses/licenses.ts` file. You should add licenses -for the package itself and for all transitive depndencies. If you forgot to add a license, the +for the package itself and for all transitive dependencies. If you forgot to add a license, the `Documentation:check_licenses` test will fail. After the update, commit all changes to the repository (including `yarn.lock`). diff --git a/Documentation/dev-crafting-changes.txt b/Documentation/dev-crafting-changes.txt index ac0780da71..6150c20890 100644 --- a/Documentation/dev-crafting-changes.txt +++ b/Documentation/dev-crafting-changes.txt @@ -28,7 +28,7 @@ guidelines: might take a while until you could benefit from it. In that case, implement the feature on master and, if you really need it on an earlier `stable-*` branch, cherry-pick the change and build - Gerrit on your own environent. + Gerrit in your own environment. * Bug-fixes should generally at least cover the oldest affected and still supported version. If you're affected and run an even older version, you're welcome to upload to that older version, even if diff --git a/Documentation/dev-design.txt b/Documentation/dev-design.txt index 5636dfda3d..176b53f2ee 100644 --- a/Documentation/dev-design.txt +++ b/Documentation/dev-design.txt @@ -98,7 +98,7 @@ port, bypassing the HTTP server used by browsers. User authentication is handled by identity realms. Gerrit supports the following types of authentication: -* OpenId (see link:http://openid.net/developers/specs/[OpenID Specifications,role=external,window=_blank]) +* OpenID (see link:http://openid.net/developers/specs/[OpenID Specifications,role=external,window=_blank]) * OAuth2 * LDAP * Google accounts (on googlesource.com) @@ -373,7 +373,7 @@ Gerrit supports the Git wire protocol, and an API (one API for HTTP, and one for SSH). The git wire protocol does a client/server negotiation to avoid -sending too much data. This negotation occupies a CPU, so the number +sending too much data. This negotiation occupies a CPU, so the number of concurrent push/fetch operations should be capped by the number of CPUs. diff --git a/Documentation/dev-eclipse.txt b/Documentation/dev-eclipse.txt index 79febe49d9..735309239d 100644 --- a/Documentation/dev-eclipse.txt +++ b/Documentation/dev-eclipse.txt @@ -61,9 +61,10 @@ on Mac too. Edit, or create, the `$HOME/.bazelrc` file and add the following lin startup --output_user_root=/Users/johndoe/.cache/bazel ---- -==== Increase the treshold for the cleanup of temporary files -The default treshold for the cleanup can be overriden by creating a configuration file under -`/etc/periodic.conf` and setting a larger value for the `daily_clean_tmps_days`. +==== Increase the threshold for the cleanup of temporary files +The default threshold for the cleanup can be overridden by creating a configuration +file under `/etc/periodic.conf` and setting a larger value for the +`daily_clean_tmps_days`. An example `/etc/periodic.conf` file: diff --git a/Documentation/dev-intellij.txt b/Documentation/dev-intellij.txt index 149b14a208..49fdc8f11c 100644 --- a/Documentation/dev-intellij.txt +++ b/Documentation/dev-intellij.txt @@ -31,13 +31,13 @@ indicates that the Bazel plugin couldn't find Java 11. === Installation of IntelliJ IDEA Please refer to the -link:https://www.jetbrains.com/help/idea/installation-guide.html[installation guide provided by Jetbrains,role=external,window=_blank] +link:https://www.jetbrains.com/help/idea/installation-guide.html[installation guide provided by JetBrains,role=external,window=_blank] to install it on your platform. Make sure to install a version compatible with the Bazel plugin as mentioned above. == Installation of the Bazel plugin -The plugin is usually installed using the Jetbrains plugin repository as shown +The plugin is usually installed using the JetBrains plugin repository as shown in the steps below, but it's also possible to link:https://github.com/bazelbuild/intellij[build it from source]. diff --git a/Documentation/dev-plugins.txt b/Documentation/dev-plugins.txt index cdc4833523..f577000804 100644 --- a/Documentation/dev-plugins.txt +++ b/Documentation/dev-plugins.txt @@ -963,7 +963,7 @@ additional parameters. When calling command options not provided by your plugin, there is always a risk that the options may not exist, perhaps because the options being called are to be provided by another plugin, and said plugin is not -currently installed. To protect againt this situation, it is possible to +currently installed. To protect against this situation, it is possible to define an option as being dependent on other options using the @RequiresOptions() annotation. If the required options are not all not currently present, then the dependent option will not be available or @@ -999,7 +999,7 @@ public class JsonOutputOptionHandler<T> extends OptionHandler<T> { @RequiresOptions("--format") @Option( name = "--special", - usage = "ouptut results using json", + usage = "output results using json", handler = JsonOutputOptionHandler.class ) boolean json; @@ -2722,7 +2722,7 @@ randomness. Plugins are expected to support rules inheritance themselves, providing ways to configure it and handling the logic behind it. Please note that no inheritance is sometimes better than badly handled -inheritance: mis-communication and strange behaviors caused by inheritance +inheritance: miscommunication and strange behaviors caused by inheritance may and will confuse the users. Each plugins is responsible for handling the project hierarchy and taking wise actions. Gerrit does not enforce it. diff --git a/Documentation/dev-readme.txt b/Documentation/dev-readme.txt index 6ff064cc2c..70f41af075 100644 --- a/Documentation/dev-readme.txt +++ b/Documentation/dev-readme.txt @@ -178,7 +178,7 @@ copying to the test site: NOTE: To learn why using `java -jar` isn't sufficient, see <<special_bazel_java_version,this explanation>>. -NOTE: When launching the daemong this way, the settings from the `[container]` section from the +NOTE: When launching the daemon this way, the settings from the `[container]` section from the `$GERRIT_SITE/etc/gerrit.config` are not honored. To debug the Gerrit server of this test site: |