General doc grammar and typos
This commit is contained in:
+1
-1
@@ -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=~``.
|
||||
|
||||
|
||||
+3
-3
@@ -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
|
||||
|
||||
+1
-1
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
+1
-1
@@ -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.
|
||||
|
||||
+1
-1
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user