Merge branch 'main' into main

Author: rafaeloledo

AUTHORS

@@ -83,6 +83,7 @@ Edd Barrett <[email protected]>
 eddsalkield <[email protected]>
 Emil Lundberg <[email protected]>
 Eric P <[email protected]>
+Ethan <[email protected]>
 Evgeny Kuznetsov <[email protected]>
 fejese <[email protected]>
 Felix Ableitner (Nutomic) <[email protected]>
@@ -233,6 +234,7 @@ terrycloth <[email protected]>
 terzinnorbert <[email protected]>
 theincogtion <[email protected]>
 Thomas Dalichow <[email protected]>
+Thomas De Rocker <[email protected]>
 Thovthe <[email protected]>
 Tim Abell <[email protected]>
 Tim Boudreau <[email protected]>

advanced/device-numconnections.rst

@@ -4,9 +4,7 @@ numConnections
 .. versionadded:: 1.25.0
 
 ``numConnections`` is a device setting that affects connection handling. A
-zero value means to use the Syncthing default. As of version 1.25.0 the
-default is to use one connection, like earlier versions of Syncthing. This
-may change in the future.
+zero value means to use the Syncthing default.
 
 Multiple connections will be maintained to the device if you set this to a
 value greater than one. Multiple connections can yield improved performance

advanced/option-database-tuning.rst

@@ -15,6 +15,7 @@
 import sys
 import os
 import re
+from datetime import datetime
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -55,15 +56,16 @@
 
 # General information about the project.
 project = u'Syncthing'
-copyright = u'2014-2019, The Syncthing Authors'
+year = datetime.now().year
+copyright = f'2014-{year}, The Syncthing Authors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
 
-release = 'v1'
+release = 'v2'
 try:
     release = open('RELEASE', 'r').read().strip()
 except FileNotFoundError:

conf.py

@@ -32,7 +32,10 @@ Prerequisites
 -  The latest stable version of Go. The previous stable version should also
    work; older versions will likely not work. This largely follows Go's
    `Release Policy <https://go.dev/doc/devel/release#policy>`__.
--  Git
+-  Usually, a C compiler. Syncthing uses SQLite for storing data and the
+   most common implementation is written in C.
+-  Git, unless you're building from a downloaded source tarball that includes
+   a ``RELEASE`` marker with the version information.
 -  If you want to build Debian packages FPM is required. See FPM's
    `installation information <https://fpm.readthedocs.io/en/latest/installation.html>`__.
 -  To build Windows executables, installing `goversioninfo
@@ -44,11 +47,6 @@ 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
 https://go.dev/doc/install.
 
-.. note::
-        Because Syncthing uses Go modules you do not need to set or care about "GOPATH".
-        However, the GOPATH still defaults to ``~/go`` and you'd be best to *not*
-        put your Syncthing source in there, for now.
-
 Building (Unix)
 ---------------
 
@@ -109,7 +107,13 @@ The following ``build.go`` subcommands and options exist.
 ``go run build.go build``
   Builds just the named target, or ``syncthing`` by default, to the current
   directory. Use this when cross compiling, with parameters for what to cross
-  compile to: ``go run build.go --goos linux --goarch 386 build``.
+  compile to: ``go run build.go --goos linux --goarch 386 build``. When
+  cross compiling you need to have a C compiler for the target platform, and
+  you need to let Go know how to invoke it. The ``--cc`` flag to build.go
+  controls this, together with the environment variable ``CGO_ENABLED=1``.
+  For example, to cross build from Linux to Windows using Zig as the C
+  compiler, ``go run build.go -goos windows -goarch amd64 -cc "zig cc
+  -target x86_64-windows" build``.
 
 ``go run build.go test``
   Runs the tests.
@@ -120,11 +124,13 @@ The following ``build.go`` subcommands and options exist.
 
 ``go run build.go tar``
   Creates a Syncthing tar.gz dist file in the current directory. Assumes a
-  Unixy build.
+  Unixy build. Otherwise same considerations and parameters as for the
+  ``build`` subcommand.
 
 ``go run build.go zip``
   Creates a Syncthing zip dist file in the current directory. Assumes a
-  Windows build.
+  Windows build. Otherwise same considerations and parameters as for the
+  ``build`` subcommand.
 
 The options ``--no-upgrade``, ``--goos`` and ``--goarch`` can be given to
 influence ``build``, ``tar`` and ``zip``. Examples:

dev/building.rst

@@ -8,12 +8,6 @@ quite silent about it. A number of environment variables can be used to
 set the logging to verbose for various parts of the program, and to
 enable profiling.
 
-Enabling any of the STTRACE facilities will also change the log format to
-include microsecond timestamps and file names plus line numbers. This
-can be used to enable this extra information on the normal logging
-level, without enabling any debugging: ``STTRACE=somethingnonexistent``
-for example.
-
 Under Unix (including Mac) the easiest way to run Syncthing with an
 environment variable set is to prepend the variable to the command line.
 I.e:

dev/debugging.rst

@@ -1,127 +1,46 @@
 STTRACE
-    Used to increase the debugging verbosity in specific or all facilities,
-    generally mapping to a Go package. Enabling any of these also enables
-    microsecond timestamps, file names plus line numbers. Enter a
-    comma-separated string of facilities to trace. ``syncthing --help`` always
-    outputs an up-to-date list. The valid facility strings are:
-
-    Main and operational facilities:
-        config
-            Configuration loading and saving.
-        db
-            The database layer.
-        main
-            Main package.
-        model
-            The root hub; the largest chunk of the system. File pulling, index
-            transmission and requests for chunks.
-        scanner
-            File change detection and hashing.
-        versioner
-            File versioning.
-
-    Networking facilities:
-        beacon
-            Multicast and broadcast UDP discovery packets: Selected interfaces
-            and addresses.
-        connections
-            Connection handling.
-        dialer
-            Dialing connections.
-        discover
-            Remote device discovery requests, replies and registration of
-            devices.
-        nat
-            NAT discovery and port mapping.
-        pmp
-            NAT-PMP discovery and port mapping.
-        protocol
-            The BEP protocol.
-        relay
-            Relay interaction (``strelaysrv``).
-        upnp
-            UPnP discovery and port mapping.
-
-    Other facilities:
-        fs
-            Filesystem access.
-        events
-            Event generation and logging.
-        http
-           REST API.
-        sha256
-            SHA256 hashing package (this facility currently unused).
-        stats
-            Persistent device and folder statistics.
-        sync
-            Mutexes. Used for debugging race conditions and deadlocks.
-        upgrade
-            Binary upgrades.
-        walkfs
-            Filesystem access while walking.
-
-        all
-            All of the above.
-
-STBLOCKPROFILE
-    Write block profiles to ``block-$pid-$timestamp.pprof`` every 20 seconds.
-
-STCPUPROFILE
-    Write a CPU profile to ``cpu-$pid.pprof`` on exit.
-
-STDEADLOCKTIMEOUT
-    Used for debugging internal deadlocks; sets debug sensitivity. Use only
-    under direction of a developer.
+    Used to increase the debugging verbosity in specific facilities,
+    generally mapping to a Go package. Enter a comma-separated string of
+    facilities to trace: ``api,beacon``. Optionally, a log level can be
+    given per facility to specify something other than DEBUG:
+    ``api:WARN,beacon:ERR``, potentially overriding a global ``--log-level``
+    adjustment.
+
+     The valid facility strings are listed below; additionally, ``syncthing
+     serve --help`` always outputs the most up-to-date list.
+
+        api             - REST API
+        beacon          - Multicast and broadcast discovery
+        config          - Configuration loading and saving
+        connections     - Connection handling
+        db/sqlite       - SQLite database
+        dialer          - Dialing connections
+        discover        - Remote device discovery
+        events          - Event generation and logging
+        fs              - Filesystem access
+        main            - Main package
+        model           - The root hub
+        nat             - NAT discovery and port mapping
+        pmp             - NAT-PMP discovery and port mapping
+        protocol        - The BEP protocol
+        relay/client    - Relay client
+        scanner         - File change detection and hashing
+        stun            - STUN functionality
+        syncthing       - Main run facility
+        upgrade         - Binary upgrades
+        upnp            - UPnP discovery and port mapping
+        ur              - Usage reporting
+        versioner       - File versioning
+        watchaggregator - Filesystem event watcher
 
 STLOCKTHRESHOLD
     Used for debugging internal deadlocks; sets debug sensitivity. Use only
     under direction of a developer.
 
-STGUIADDRESS
-    Override GUI listen address.  Equivalent to passing :option:`--gui-address`.
-
-STGUIAPIKEY
-    Override the API key needed to access the GUI / REST API.  Equivalent to
-    passing :option:`--gui-apikey`.
-
-STGUIASSETS
-    Directory to load GUI assets from. Overrides compiled in assets. Useful for
-    developing webgui, commonly use ``STGUIASSETS=gui bin/syncthing``.
-
-STHEAPPROFILE
-    Write heap profiles to ``heap-$pid-$timestamp.pprof`` each time heap usage
-    increases.
-
-STNODEFAULTFOLDER
-    Don't create a default folder when starting for the first time. This
-    variable will be ignored anytime after the first run.  Equivalent to the
-    :option:`--no-default-folder` flag.
-
-STNORESTART
-    Equivalent to the :option:`--no-restart` flag.
-
-STNOUPGRADE
-    Disable automatic upgrades.  Equivalent to the :option:`--no-upgrade` flag.
-
-STPROFILER
-    Set to a listen address such as "127.0.0.1:9090" to start the profiler with
-    HTTP access, which then can be reached at
-    http://localhost:9090/debug/pprof. See ``go tool pprof`` for more
-    information.
-
-STPERFSTATS
-    Write running performance statistics to ``perf-$pid.csv``. Not supported on
-    Windows.
-
-STRECHECKDBEVERY
-    Time before folder statistics (file, dir, ... counts) are recalculated from
-    scratch. The given duration must be parseable by Go's ``time.ParseDuration``. If
-    missing or not parseable, the default value of 1 month is used. To force
-    recalculation on every startup, set it to ``1s``.
-
-STGCINDIRECTEVERY
-    Sets the time interval in between database garbage collection runs.  The
-    given duration must be parseable by Go's ``time.ParseDuration``.
+STVERSIONEXTRA
+    Add extra information to the version string in logs and the version line
+    in the GUI. Can be set to the name of a wrapper or tool controlling
+    syncthing to communicate this to the end user.
 
 GOMAXPROCS
     Set the maximum number of CPU cores to use. Defaults to all available CPU

includes/env-vars.rst

@@ -1,24 +1,6 @@
 Debug Endpoints
 ================
 
-These endpoints require the :stconf:opt:`gui.debugging` configuration option to
-be enabled and yield an access denied error code otherwise.
-
-
-GET /rest/debug/peerCompletion
-------------------------------
-
-Summarizes the completion percentage for each remote device.  Returns an object
-with device IDs as keys and an integer percentage as values.
-
-
-GET /rest/debug/httpmetrics
----------------------------
-
-Returns statistics about each served REST API endpoint, to diagnose how much
-time was spent generating the responses.
-
-
 GET /rest/debug/cpuprof
 -----------------------
 

rest/debug.rst

@@ -50,9 +50,7 @@ Returns the current configuration.
           "pullerPauseS": 0,
           "maxConflicts": -1,
           "disableSparseFiles": false,
-          "disableTempIndexes": false,
           "paused": false,
-          "weakHashThresholdPct": 25,
           "markerName": ".stfolder",
           "copyOwnershipFromParent": false,
           "modTimeWindowS": 0,
@@ -105,7 +103,6 @@ Returns the current configuration.
         "apiKey": "k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1",
         "insecureAdminAccess": false,
         "theme": "default",
-        "debugging": false,
         "insecureSkipHostcheck": false,
         "insecureAllowFrameLoading": false
       },
@@ -171,7 +168,6 @@ Returns the current configuration.
         "stunServers": [
           "default"
         ],
-        "databaseTuning": "auto",
         "maxConcurrentIncomingRequestKiB": 0,
         "announceLANAddresses": true,
         "sendFullIndexOnUpgrade": false,
@@ -226,9 +222,7 @@ Returns the current configuration.
           "pullerPauseS": 0,
           "maxConflicts": 10,
           "disableSparseFiles": false,
-          "disableTempIndexes": false,
           "paused": false,
-          "weakHashThresholdPct": 25,
           "markerName": ".stfolder",
           "copyOwnershipFromParent": false,
           "modTimeWindowS": 0,