summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Yaroslav Halchenko <debian@onerussian.com>2014-12-04 22:25:00 -0500
committerGravatar Yaroslav Halchenko <debian@onerussian.com>2014-12-04 22:28:07 -0500
commit145440be192be7e01e0f6d0f2303deb5a8ab363e (patch)
tree5f12d757dcade384e48cda605214fe40fb19d222
parent90abaecfe4a1ace55e5229cffd2020ccbc3f6ab8 (diff)
DOC: minor typos and rewording in few docs
-rw-r--r--doc/design/external_special_remote_protocol.mdwn14
-rw-r--r--doc/internals.mdwn12
2 files changed, 13 insertions, 13 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn
index 01ffe7fd4..70ece65e1 100644
--- a/doc/design/external_special_remote_protocol.mdwn
+++ b/doc/design/external_special_remote_protocol.mdwn
@@ -91,14 +91,14 @@ send one of the corresponding replies listed in the next section.
The following requests *must* all be supported by the special remote.
* `INITREMOTE`
- Request that the remote initialize itself. This is where any one-time
+ Requests the remote to initialize itself. This is where any one-time
setup tasks can be done, for example creating an Amazon S3 bucket.
Note: This may be run repeatedly over time, as a remote is initialized in
different repositories, or as the configuration of a remote is changed.
(Both `git annex initremote` and `git-annex enableremote` run this.)
So any one-time setup tasks should be done idempotently.
* `PREPARE`
- Tells the special remote it's time to prepare itself to be used.
+ Tells the remote that it's time to prepare itself to be used.
Only INITREMOTE can come before this.
* `TRANSFER STORE|RETRIEVE Key File`
Requests the transfer of a key. For STORE, the File is the file to upload;
@@ -110,20 +110,20 @@ The following requests *must* all be supported by the special remote.
Multiple transfers might be requested by git-annex, but it's fine for the
program to serialize them and only do one at a time.
* `CHECKPRESENT Key`
- Requests the remote check if a key is present in it.
+ Requests the remote to check if a key is present in it.
* `REMOVE Key`
- Requests the remote remove a key's contents.
+ Requests the remote to remove key's contents.
The following requests can optionally be supported. If not handled,
replying with `UNSUPPORTED-REQUEST` is acceptable.
* `GETCOST`
- Requests the remote return a use cost. Higher costs are more expensive.
+ Requests the remote to return a use cost. Higher costs are more expensive.
(See Config/Cost.hs for some standard costs.)
* `GETAVAILABILITY`
- Requests the remote send back an `AVAILABILITY` reply.
+ Requests the remote to send back an `AVAILABILITY` reply.
If the remote replies with `UNSUPPORTED-REQUEST`, its availability
- is asssumed to be global. So, only remotes that are only reachable
+ is assumed to be global. So, only remotes that are only reachable
locally need to worry about implementing this.
More optional requests may be added, without changing the protocol version,
diff --git a/doc/internals.mdwn b/doc/internals.mdwn
index ca2b7b41f..9970a0bbd 100644
--- a/doc/internals.mdwn
+++ b/doc/internals.mdwn
@@ -17,7 +17,7 @@ See [[hashing]] for details.
Each subdirectory has the [[name_of_a_key|key_format]] in one of the
[[key-value_backends|backends]]. The file inside also has the name of the key.
This two-level structure is used because it allows the write bit to be removed
-from the subdirectories as well as from the files. That prevents accidentially
+from the subdirectories as well as from the files. That prevents accidentally
deleting or changing the file contents. See [[lockdown]] for details.
In [[direct_mode]], file contents are not stored in here, and instead
@@ -158,7 +158,7 @@ File format is identical to preferred-content.log.
## `group-preferred-content.log`
Contains standard preferred content settings for groups. (Overriding or
-supplimenting the ones built into git-annex.)
+supplementing the ones built into git-annex.)
The file format is one line per group, staring with a timestamp, then a
space, then the group name followed by a space and then the preferred
@@ -205,7 +205,7 @@ values.
Lines are timestamped, and record when values are added (`field +value`),
but also when values are removed (`field -value`). Removed values
are retained in the log so that when merging an old line that sets a value
-that was later unset, the value is not accidentially added back.
+that was later unset, the value is not accidentally added back.
For example:
@@ -214,8 +214,8 @@ For example:
The value can be completely arbitrary data, although it's typically
reasonably short. If the value contains any whitespace
-(including \r or \r), it will be base64 encoded. Base64 encoded values
-are indicated by prefixing them with "!"
+(including \r or \n), it will be base64 encoded. Base64 encoded values
+are indicated by prefixing them with "!".
## `aaa/bbb/*.log.cnk`
@@ -237,7 +237,7 @@ Used to record scheduled events, such as periodic fscks.
The file format is simply one line per repository, with the uuid followed by a
space and then its schedule, followed by a timestamp.
-There can be multiple events in the schedule, separated by "; "
+There can be multiple events in the schedule, separated by "; ".
The format of the scheduled events is the same described in
the SCHEDULED JOBS section of the man page.