From 9d40bbe3fd70b9aa14e2a63a7875418ffeeb04cf Mon Sep 17 00:00:00 2001 From: Phil Davis Date: Thu, 8 Oct 2015 22:06:15 +0545 Subject: [PATCH] General doc grammar and typos --- advanced/folder-ignoredelete.rst | 2 +- dev/building.rst | 2 +- dev/debugging.rst | 6 +++--- dev/device-ids.rst | 2 +- dev/infrastructure.rst | 2 +- dev/intro.rst | 2 +- dev/issues.rst | 2 +- dev/release-creation.rst | 2 +- draft/localver.rst | 6 +++--- draft/selective.rst | 4 ++-- events/downloadprogress.rst | 4 ++-- index.rst | 2 +- intro/gui.rst | 4 ++-- rest/db-completion-get.rst | 2 +- specs/localdisco-v3.rst | 8 ++++---- users/config.rst | 6 +++--- users/faq.rst | 4 ++-- users/reverseproxy.rst | 4 ++-- 18 files changed, 32 insertions(+), 32 deletions(-) diff --git a/advanced/folder-ignoredelete.rst b/advanced/folder-ignoredelete.rst index c37efcab8..1db542a8f 100644 --- a/advanced/folder-ignoredelete.rst +++ b/advanced/folder-ignoredelete.rst @@ -10,7 +10,7 @@ are ignored. Example Scenario ---------------- -Assume two devices, "Alice" and "Bob", sharing a folder. Bob has set +Assume two devices, "Alice" and "Bob", are sharing a folder. Bob has set ``ignoreDelete``. New and updated files are synchronized as usual between Alice and Bob. When diff --git a/dev/building.rst b/dev/building.rst index 290444dc2..70b76fcaa 100644 --- a/dev/building.rst +++ b/dev/building.rst @@ -31,7 +31,7 @@ Prerequisites - Go **1.3** or higher - Git -If you're not a Go developer since before, the easiest way to get going +If you're not already a Go developer, the easiest way to get going is to download the latest version of Go as instructed in http://golang.org/doc/install and ``export GOPATH=~``. diff --git a/dev/debugging.rst b/dev/debugging.rst index 80128bb73..9876d098c 100644 --- a/dev/debugging.rst +++ b/dev/debugging.rst @@ -44,21 +44,21 @@ facilities are something like this: - ``beacon`` sends and receives UDP broadcasts used by the local discovery system. Debugging here will show which interfaces and addresses are selected for broadcasts, etc. -- ``discover`` sends and received local discovery packets. Debugging +- ``discover`` sends and receives local discovery packets. Debugging here will output the parsed packets, nodes that get registered etc. - ``files`` keeps track of lists of files with metadata and figures out which is the newest version of each. - ``net`` shows connection attempts, incoming connections, and the low level error when connection attempts fail. - ``model`` is the largest chunk of the system; this is where pulling - of out of date files happen, indexes sent and received, and incoming + of out of date files happens, indexes are sent and received, and incoming requests for file chunks are logged. - ``scanner`` is the local filesystem scanner. Debugging here will output information about changed and unchanged files. - ``upnp`` is the upnp talker. - ``xdr`` is the low level protocol encoder. Debugging here will output all bytes sent/received over the sync connection. Very verbose. -- ``all`` simply enabled debugging of all facilities. +- ``all`` simply enables debugging of all facilities. Enabling any of the facilities will also change the log format to include microsecond timestamps and file names plus line numbers. This diff --git a/dev/device-ids.rst b/dev/device-ids.rst index 4e1472d38..c0bfc1844 100644 --- a/dev/device-ids.rst +++ b/dev/device-ids.rst @@ -206,7 +206,7 @@ It could be mitigated in several ways: - Announcements to the global announce server could be done using TLS, so the server calculates the device ID based on the certificate - instead of trusting to the device to tell the truth. + instead of trusting the device to tell the truth. - The user could statically configure IP or host name for the devices. diff --git a/dev/infrastructure.rst b/dev/infrastructure.rst index 2e243c760..3d90efe9f 100644 --- a/dev/infrastructure.rst +++ b/dev/infrastructure.rst @@ -50,7 +50,7 @@ Runs Jenkins and does the core and Android builds, Ubuntu Linux. OSX and Windows Build Slaves ---------------------------- -Runs Jenkins build slaves and run builds and tests on the Mac and +Runs Jenkins build slaves and runs builds and tests on the Mac and Windows operating systems. Hosted by :user:`Zillode`. APT Server diff --git a/dev/intro.rst b/dev/intro.rst index 72a865833..b3be0ab9b 100644 --- a/dev/intro.rst +++ b/dev/intro.rst @@ -106,7 +106,7 @@ lib/ The local and global device discovery -- maps device IDs to IP and port tuples. events/ - The event subsystem, handles emitting of and subscribing to events accross the other packages. + The event subsystem, handles emitting of and subscribing to events across the other packages. fnmatch/ Matches strings to glob patterns, used by the ignore package. diff --git a/dev/issues.rst b/dev/issues.rst index d4ecafaf2..384fb8700 100644 --- a/dev/issues.rst +++ b/dev/issues.rst @@ -63,7 +63,7 @@ protocol Milestone --------- -There are milestones for major and sometimes minor versions. An issues +There are milestones for major and sometimes minor versions. An issue being assigned to a milestone means it is a blocker - the release can't be made without the issue being closed. Issues not assigned to a milestone can be handled whenever. diff --git a/dev/release-creation.rst b/dev/release-creation.rst index a28aad861..5569248bb 100644 --- a/dev/release-creation.rst +++ b/dev/release-creation.rst @@ -44,7 +44,7 @@ Tag". Set the "Release title" to the same version as the tag, paste in the changelog from above, and publish the release. On the signing server, logged in via ssh, run ``sign-upload-release``. This -will create download the build artefacts from Jenkins, sign all the binaries, +will download the build artefacts from Jenkins, sign all the binaries, create the sha1sum and sha256sum files, sign them with the release GPG key and upload the whole shebang to Github. diff --git a/draft/localver.rst b/draft/localver.rst index c415260bf..da7f336a5 100644 --- a/draft/localver.rst +++ b/draft/localver.rst @@ -19,14 +19,14 @@ device. Each time a change is made to the index information of an item (file or directory), that item is tagged with the current value of the local version counter, and the counter is increased. -Principal Operation -------------------- +Principal of Operation +---------------------- Assume that the starting value of the counter is ``0``. The next change that happens will be assigned local version ``1``. Local scanning reveals the presence of three new files, ``foo``, ``bar`` and ``baz``. When ``foo`` is discovered, it's index entry gets assigned local version ``1`` and the counter -is increased. Likewise ``bar`` gets ``2`` and ``foo`` gets ``3``. +is increased. Likewise ``bar`` gets ``2`` and ``baz`` gets ``3``. ==== ============= File Local Version diff --git a/draft/selective.rst b/draft/selective.rst index 18f0a4d42..06f30b1e5 100644 --- a/draft/selective.rst +++ b/draft/selective.rst @@ -4,7 +4,7 @@ Selective Sync ============== This is for when you don't want to synchronize *all* files from the cluster -onto your device, or you want only some directories of your to be synced +onto your device, or you want only some directories of yours to be synced *to* the cluster. There are two mechanisms that support this usage; *Directory Selection* and *Excluded Files*. @@ -50,7 +50,7 @@ changes will be downloaded from the cluster and local changes will not be tracked. .. note:: When displaying the tree we must merge what we actually have on disk - with what is in the global state.Or we will not be able to show new + with what is in the global state, or we will not be able to show new directories to the user as we don't know about them... diff --git a/events/downloadprogress.rst b/events/downloadprogress.rst index 801873f4f..b2229d35d 100644 --- a/events/downloadprogress.rst +++ b/events/downloadprogress.rst @@ -75,6 +75,6 @@ Where block size is 128KB. Files/folders appearing in the event data imply that the download has been started for that file/folder, where disappearing implies that the -downloads has been finished or failed for that file/folder. There is +downloads have been finished or failed for that file/folder. There is always a last event emitted with no data, which implies all downloads -being finished/failed. +have finished/failed. diff --git a/index.rst b/index.rst index 9777f809e..d8cbdea1b 100644 --- a/index.rst +++ b/index.rst @@ -22,7 +22,7 @@ Contact :ref:`project-presentation`. * To report bugs or request features, please use the `issue tracker`_ Before you - do so, make sure you are running the `latest version`_, and please do a + do so, make sure you are running the `latest version`_, and please do a quick search to see if the issue has already been reported. .. image:: issues.png diff --git a/intro/gui.rst b/intro/gui.rst index 395de7c36..3e8cd1fec 100644 --- a/intro/gui.rst +++ b/intro/gui.rst @@ -23,7 +23,7 @@ Stopped when the folder has experienced an error, Scanning - while the folder is looking for local changes, + while Syncthing is looking in the folder for local changes, Up to Date when the folder is in sync with the rest of the cluster, @@ -40,7 +40,7 @@ Local State shows how much data the folder actually contains right now. This can be more or less than the global state, if the folder is currently synchronizing with other devices. Out of Sync - shows how much data that needs to be synchronized from other devices. Note that this is the sum of all out of sync *files* - if you already have parts of such a file, or an older version of the file, less data than this will need to be transferred over the network. + shows how much data needs to be synchronized from other devices. Note that this is the sum of all out of sync *files* - if you already have parts of such a file, or an older version of the file, less data than this will need to be transferred over the network. Device View ----------- diff --git a/rest/db-completion-get.rst b/rest/db-completion-get.rst index b8115a2f3..9f5c925d8 100644 --- a/rest/db-completion-get.rst +++ b/rest/db-completion-get.rst @@ -2,7 +2,7 @@ GET /rest/db/completion ======================= Returns the completion percentage (0 to 100) for a given device and -folder.Takes ``device`` and ``folder`` parameters. +folder. Takes ``device`` and ``folder`` parameters. .. code-block:: json diff --git a/specs/localdisco-v3.rst b/specs/localdisco-v3.rst index 0a89053bc..1abae10a0 100644 --- a/specs/localdisco-v3.rst +++ b/specs/localdisco-v3.rst @@ -11,11 +11,11 @@ reply; the only message type is Announcement. On multihomed hosts the announcement packets should be sent on each interface on which Syncthing will accept connections. -For IPv4, the Announcement packet is broadcasted either to the link-specific +For IPv4, the Announcement packet is broadcast either to the link-specific broadcast address, or to the generic link-local broadcast address ``255.255.255.255``, with destination port 21027. -For IPv6, the Announcement packet is multicasted to the transient link-local +For IPv6, the Announcement packet is multicast to the transient link-local multicast address ``[ff12::8384]``, with destination port 21027. It is recommended that local discovery Announcement packets be sent on a 30 to @@ -44,7 +44,7 @@ The Announcement packet has the following structure:: \ Device Structure \ / / +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Number of Extra | + | Number of Extra Devices | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ / / \ Zero or more Device Structures \ @@ -136,7 +136,7 @@ bytes) of the device X.509 certificate, as explained in section *Device ID*. For each ``Address`` and ``Relay`` the ``URL`` field contains the actual -target address. For direction connections (the ``Address`` list) these will +target address. Direct connections (the ``Address`` list) will typically have the ``tcp://`` scheme. Relay connections will typically use the ``relay://`` scheme. diff --git a/users/config.rst b/users/config.rst index 097a11a4a..423b3ebe6 100644 --- a/users/config.rst +++ b/users/config.rst @@ -43,7 +43,7 @@ directory the following files are located: Config File Format ------------------ -The following is shows the default configuration file: +The following shows the default configuration file: .. code-block:: xml @@ -123,7 +123,7 @@ id The folder ID, must be unique. (mandatory) path - The oath to the directory where the folder is stored on this + The path to the directory where the folder is stored on this device; not sent to other devices. (mandatory) ro @@ -339,7 +339,7 @@ globalAnnounceServer globalAnnounceEnabled Whether to announce this device to the global announce (discovery) server, - and also use it to look up other device. + and also use it to look up other devices. localAnnounceEnabled Whether to send announcements to the local LAN, also use such diff --git a/users/faq.rst b/users/faq.rst index 426503387..ee717e513 100644 --- a/users/faq.rst +++ b/users/faq.rst @@ -142,7 +142,7 @@ safe from your (or our) mistakes. Why is there no iOS client? ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Alternative implementation Syncthing (using the Syncthing protocol) are being +An alternative implementation of Syncthing (using the Syncthing protocol) is being developed at this point in time to enable iOS support. Additionally, it seems that the next version of Go will support the darwin-arm architecture such that we can compile the mainstream code for the iOS platform. @@ -230,7 +230,7 @@ Where do Syncthing logs go to? Syncthing logs to stdout by default. On Windows Syncthing by default also creates ``syncthing.log`` in Syncthing's home directory (check ``-help`` to see -where that is). Command line option ``-logfile`` can be used to specify user-defined logfile. +where that is). Command line option ``-logfile`` can be used to specify a user-defined logfile. How do I upgrade Syncthing? ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/users/reverseproxy.rst b/users/reverseproxy.rst index b929d0bc0..02714ba9e 100644 --- a/users/reverseproxy.rst +++ b/users/reverseproxy.rst @@ -3,7 +3,7 @@ Reverse Proxy Setup =================== -A reverse proxy allow you to "pass" requests through your web server to another +A reverse proxy allows you to "pass" requests through your web server to another site or program. The reverse proxy will make it look like Syncthing's GUI is a page within your existing site. @@ -12,7 +12,7 @@ This is especially useful if: - You need to access the GUI on port 80 or 443 but you already host a website on the same device. - You want to share SSL certificates with an existing site. -- You want to share authentification with an existing setup. +- You want to share authentication with an existing setup. Server Configuration --------------------