mirror of
https://github.com/octoleo/syncthing.git
synced 2024-11-19 19:45:12 +00:00
all: Correct various typos
Skip-check: authors GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/4005
This commit is contained in:
parent
98d22b88a0
commit
c56c48a777
4
GOALS.md
4
GOALS.md
@ -1,6 +1,6 @@
|
|||||||
# The Syncthing Goals
|
# The Syncthing Goals
|
||||||
|
|
||||||
Syncthing is a **continous file synchronization program**. It synchronizes
|
Syncthing is a **continuous file synchronization program**. It synchronizes
|
||||||
files between two or more computers. We strive to fulfill the goals below.
|
files between two or more computers. We strive to fulfill the goals below.
|
||||||
The goals are listed in order of importance, the most important one being
|
The goals are listed in order of importance, the most important one being
|
||||||
the first.
|
the first.
|
||||||
@ -80,4 +80,4 @@ conflict with the stated goals above.
|
|||||||
> providing entertainment value for the maintainers are also things that
|
> providing entertainment value for the maintainers are also things that
|
||||||
> matter. It is understood that there are aspects of Syncthing that are
|
> matter. It is understood that there are aspects of Syncthing that are
|
||||||
> suboptimal or even in opposition with the goals above. However, we
|
> suboptimal or even in opposition with the goals above. However, we
|
||||||
> continously strive to align Syncthing more and more with these goals.
|
> continuously strive to align Syncthing more and more with these goals.
|
||||||
|
@ -48,7 +48,7 @@
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<div id="map"></div> <!-- Can't hide the map, otherwise it freaks out -->
|
<div id="map"></div> <!-- Can't hide the map, otherwise it freaks out -->
|
||||||
<p>The circle size represents how much bytes the relay transfered relative to other relays</p>
|
<p>The circle size represents how much bytes the relay transferred relative to other relays</p>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<table class="table table-striped table-condensed table">
|
<table class="table table-striped table-condensed table">
|
||||||
|
@ -6,7 +6,7 @@ This is the relay server for the `syncthing` project.
|
|||||||
:exclamation:Warnings:exclamation: - Read or regret
|
:exclamation:Warnings:exclamation: - Read or regret
|
||||||
-----
|
-----
|
||||||
|
|
||||||
By default, all relay servers will join to the default public relay pool, which means that the relay server will be availble for public use, and **will consume your bandwidth** helping others to connect.
|
By default, all relay servers will join to the default public relay pool, which means that the relay server will be available for public use, and **will consume your bandwidth** helping others to connect.
|
||||||
|
|
||||||
If you wish to disable this behaviour, please specify the `-pools=""` argument.
|
If you wish to disable this behaviour, please specify the `-pools=""` argument.
|
||||||
|
|
||||||
|
@ -633,7 +633,7 @@ func syncthingMain(runtimeOptions RuntimeOptions) {
|
|||||||
// report the error if there is one.
|
// report the error if there is one.
|
||||||
osutil.MaximizeOpenFileLimit()
|
osutil.MaximizeOpenFileLimit()
|
||||||
|
|
||||||
// Ensure that that we have a certificate and key.
|
// Ensure that we have a certificate and key.
|
||||||
cert, err := tls.LoadX509KeyPair(locations[locCertFile], locations[locKeyFile])
|
cert, err := tls.LoadX509KeyPair(locations[locCertFile], locations[locKeyFile])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
l.Infof("Generating ECDSA key and certificate for %s...", tlsDefaultCommonName)
|
l.Infof("Generating ECDSA key and certificate for %s...", tlsDefaultCommonName)
|
||||||
|
@ -30,7 +30,7 @@ angular.module('syncthing.core')
|
|||||||
var aboveLargestZ = largestZ + 10;
|
var aboveLargestZ = largestZ + 10;
|
||||||
$(element).css('zIndex', aboveLargestZ);
|
$(element).css('zIndex', aboveLargestZ);
|
||||||
|
|
||||||
// set backdrop z-index. timeout used because element does not exist immediatly
|
// set backdrop z-index. timeout used because element does not exist immediately
|
||||||
setTimeout(function () {
|
setTimeout(function () {
|
||||||
$('.modal-backdrop:not(:last)').removeClass('in').addClass('out');
|
$('.modal-backdrop:not(:last)').removeClass('in').addClass('out');
|
||||||
$('.modal-backdrop:last').attr('for-modal-id', $(element).attr('id')).css('zIndex', aboveLargestZ - 5);
|
$('.modal-backdrop:last').attr('for-modal-id', $(element).attr('id')).css('zIndex', aboveLargestZ - 5);
|
||||||
|
@ -137,7 +137,7 @@ func NewService(cfg *config.Wrapper, myID protocol.DeviceID, mdl Model, tlsCfg *
|
|||||||
// There are several moving parts here; one routine per listening address
|
// There are several moving parts here; one routine per listening address
|
||||||
// (handled in configuration changing) to handle incoming connections,
|
// (handled in configuration changing) to handle incoming connections,
|
||||||
// one routine to periodically attempt outgoing connections, one routine to
|
// one routine to periodically attempt outgoing connections, one routine to
|
||||||
// the the common handling regardless of whether the connection was
|
// the common handling regardless of whether the connection was
|
||||||
// incoming or outgoing.
|
// incoming or outgoing.
|
||||||
|
|
||||||
service.Add(serviceFunc(service.connect))
|
service.Add(serviceFunc(service.connect))
|
||||||
|
@ -212,7 +212,7 @@ func (t *ProgressEmitter) Register(s *sharedPullerState) {
|
|||||||
if len(t.registry) == 0 {
|
if len(t.registry) == 0 {
|
||||||
t.timer.Reset(t.interval)
|
t.timer.Reset(t.interval)
|
||||||
}
|
}
|
||||||
// Separate the folder ID (arbitrary string) and and the file name by "//"
|
// Separate the folder ID (arbitrary string) and the file name by "//"
|
||||||
// because it never appears in a valid file name.
|
// because it never appears in a valid file name.
|
||||||
t.registry[s.folder+"//"+s.file.Name] = s
|
t.registry[s.folder+"//"+s.file.Name] = s
|
||||||
}
|
}
|
||||||
|
@ -137,7 +137,7 @@ func TestNewDeviceIDMarshalling(t *testing.T) {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Create an old style message and and attempt unmarshal
|
// Create an old style message and attempt unmarshal
|
||||||
|
|
||||||
var msg2 TestOldDeviceID
|
var msg2 TestOldDeviceID
|
||||||
if err := msg2.Unmarshal(bs); err != nil {
|
if err := msg2.Unmarshal(bs); err != nil {
|
||||||
|
@ -71,7 +71,7 @@ type Config struct {
|
|||||||
ProgressTickIntervalS int
|
ProgressTickIntervalS int
|
||||||
// Signals cancel from the outside - when closed, we should stop walking.
|
// Signals cancel from the outside - when closed, we should stop walking.
|
||||||
Cancel chan struct{}
|
Cancel chan struct{}
|
||||||
// Wether or not we should also compute weak hashes
|
// Whether or not we should also compute weak hashes
|
||||||
UseWeakHashes bool
|
UseWeakHashes bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -391,7 +391,7 @@ func verifyUpgrade(archiveName, tempName string, sig []byte) error {
|
|||||||
//
|
//
|
||||||
// We then verify the release signature against the contents of this
|
// We then verify the release signature against the contents of this
|
||||||
// multireader. This ensures that it is not only a bonafide syncthing
|
// multireader. This ensures that it is not only a bonafide syncthing
|
||||||
// binary, but it it also of exactly the platform and version we expect.
|
// binary, but it is also of exactly the platform and version we expect.
|
||||||
|
|
||||||
mr := io.MultiReader(bytes.NewBufferString(archiveName+"\n"), fd)
|
mr := io.MultiReader(bytes.NewBufferString(archiveName+"\n"), fd)
|
||||||
err = signature.Verify(SigningKey, sig, mr)
|
err = signature.Verify(SigningKey, sig, mr)
|
||||||
|
@ -28,7 +28,7 @@ func TestExternalNoCommand(t *testing.T) {
|
|||||||
// The versioner should fail due to missing command.
|
// The versioner should fail due to missing command.
|
||||||
|
|
||||||
e := External{
|
e := External{
|
||||||
command: "nonexistant command",
|
command: "nonexistent command",
|
||||||
folderPath: "testdata/folder path",
|
folderPath: "testdata/folder path",
|
||||||
}
|
}
|
||||||
if err := e.Archive(file); err == nil {
|
if err := e.Archive(file); err == nil {
|
||||||
|
@ -99,7 +99,7 @@ type Finder struct {
|
|||||||
|
|
||||||
// Iterate iterates all available blocks that matches the provided hash, reads
|
// Iterate iterates all available blocks that matches the provided hash, reads
|
||||||
// them into buf, and calls the iterator function. The iterator function should
|
// them into buf, and calls the iterator function. The iterator function should
|
||||||
// return wether it wishes to continue interating.
|
// return whether it wishes to continue iterating.
|
||||||
func (h *Finder) Iterate(hash uint32, buf []byte, iterFunc func(int64) bool) (bool, error) {
|
func (h *Finder) Iterate(hash uint32, buf []byte, iterFunc func(int64) bool) (bool, error) {
|
||||||
if h == nil || hash == 0 || len(buf) != h.size {
|
if h == nil || hash == 0 || len(buf) != h.size {
|
||||||
return false, nil
|
return false, nil
|
||||||
|
@ -247,12 +247,12 @@ although your milage may vary.
|
|||||||
.sp
|
.sp
|
||||||
The relay server listens on two ports by default. One for data connections and the other
|
The relay server listens on two ports by default. One for data connections and the other
|
||||||
for providing public statistics at \fI\%http://relays.syncthing.net/\fP\&. The firewall, such as
|
for providing public statistics at \fI\%http://relays.syncthing.net/\fP\&. The firewall, such as
|
||||||
\fBiptables\fP, must permit incoming TCP connetions to the following ports:
|
\fBiptables\fP, must permit incoming TCP connections to the following ports:
|
||||||
.INDENT 0.0
|
.INDENT 0.0
|
||||||
.IP \(bu 2
|
.IP \(bu 2
|
||||||
Data port: \fB22067/tcp\fP overriden with \fB\-listen\fP and advertised with \fB\-ext\-address\fP
|
Data port: \fB22067/tcp\fP overridden with \fB\-listen\fP and advertised with \fB\-ext\-address\fP
|
||||||
.IP \(bu 2
|
.IP \(bu 2
|
||||||
Status port: \fB22070/tcp\fP overriden with \fB\-status\-srv\fP
|
Status port: \fB22070/tcp\fP overridden with \fB\-status\-srv\fP
|
||||||
.UNINDENT
|
.UNINDENT
|
||||||
.sp
|
.sp
|
||||||
Runtime \fBiptables\fP rules to allow access to the default ports:
|
Runtime \fBiptables\fP rules to allow access to the default ports:
|
||||||
|
@ -211,7 +211,7 @@ everywhere else and we don\(aqt know which of the conflicting files is the "best
|
|||||||
from the user point of view. Moreover, if there\(aqs something that automatically
|
from the user point of view. Moreover, if there\(aqs something that automatically
|
||||||
causes a conflict on change you\(aqll end up with \fBsync\-conflict\-...sync\-conflict
|
causes a conflict on change you\(aqll end up with \fBsync\-conflict\-...sync\-conflict
|
||||||
\-...\-sync\-conflict\fP files.
|
\-...\-sync\-conflict\fP files.
|
||||||
.SS Am I able to use nested Synthing folders?
|
.SS Am I able to use nested Syncthing folders?
|
||||||
.sp
|
.sp
|
||||||
Do not nest shared folders. This behaviour is in no way supported,
|
Do not nest shared folders. This behaviour is in no way supported,
|
||||||
recommended or coded for in any way, and comes with many pitfalls.
|
recommended or coded for in any way, and comes with many pitfalls.
|
||||||
@ -398,12 +398,12 @@ This is almost always a result of bad RAM, storage device or other hardware. Whe
|
|||||||
You can change the theme in the settings. Syncthing ships with other themes
|
You can change the theme in the settings. Syncthing ships with other themes
|
||||||
than the default.
|
than the default.
|
||||||
.sp
|
.sp
|
||||||
If you want a custom theme or a completly different GUI, you can add your
|
If you want a custom theme or a completely different GUI, you can add your
|
||||||
own.
|
own.
|
||||||
By default, Syncthing will look for a directory \fBgui\fP inside the Syncthing
|
By default, Syncthing will look for a directory \fBgui\fP inside the Syncthing
|
||||||
home folder. To change the directory to look for themes, you need to set the
|
home folder. To change the directory to look for themes, you need to set the
|
||||||
STGUIASSETS environment variable. To get the concrete directory, run
|
STGUIASSETS environment variable. To get the concrete directory, run
|
||||||
syncthing with the \fB\-paths\fP parameter. It will print all the relevent paths,
|
syncthing with the \fB\-paths\fP parameter. It will print all the relevant paths,
|
||||||
including the "GUI override directory".
|
including the "GUI override directory".
|
||||||
.sp
|
.sp
|
||||||
To add e.g. a red theme, you can create the file \fBred/assets/css/theme.css\fP
|
To add e.g. a red theme, you can create the file \fBred/assets/css/theme.css\fP
|
||||||
|
@ -328,8 +328,8 @@ Equivalent to the \-no\-restart argument. Disable the Syncthing monitor process
|
|||||||
Disable automatic upgrades.
|
Disable automatic upgrades.
|
||||||
.TP
|
.TP
|
||||||
.B STHASHING
|
.B STHASHING
|
||||||
Specifiy which hashing package to use. Defaults to automatic based on
|
Specify which hashing package to use. Defaults to automatic based on
|
||||||
peformance. Specify "minio" (compatibility) or "standard" for the default Go implementation.
|
performance. Specify "minio" (compatibility) or "standard" for the default Go implementation.
|
||||||
.TP
|
.TP
|
||||||
.B GOMAXPROCS
|
.B GOMAXPROCS
|
||||||
Set the maximum number of CPU cores to use. Defaults to all available CPU
|
Set the maximum number of CPU cores to use. Defaults to all available CPU
|
||||||
|
Loading…
Reference in New Issue
Block a user