From 32aa78a628f359647b2cfc0a7d1e644106bd7356 Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Sat, 18 May 2024 11:01:27 -0700 Subject: [PATCH 1/4] docs: remove dead links in intro.rst --- dev/intro.rst | 39 ++++++--------------------------------- 1 file changed, 6 insertions(+), 33 deletions(-) diff --git a/dev/intro.rst b/dev/intro.rst index ec53039f6..245401af7 100644 --- a/dev/intro.rst +++ b/dev/intro.rst @@ -48,12 +48,12 @@ for the build system. The actual code lives in the ``cmd/syncthing`` and assets/ Various graphical assets -- the logo. +bin/ + Compiled packages, generated by the build process. + cmd/ Commands either built as end products or used by the build process itself. - genassets/ - Generates asset files that are compiled into ``syncthing`` as part of the build process (build utility). - stcompdirs/ Compares two directories (debugging utility). @@ -66,21 +66,9 @@ cmd/ stfinddevice/ Looks up a device on a global discovery server (debugging utility). - stindex/ - Prints index (database) contents (debugging utility). - syncthing/ Synchronizes files between devices... - todos/ - Converts line endings from Unix to DOS standard (build utility). - - transifexdl/ - Downloads translations from Transifex (build utility). - - translate/ - Generates translation source for Transifex based on the HTML source (build utility). - etc/ Startup scripts and integration files. Included as-is in the release packages. @@ -90,9 +78,6 @@ gui/ lib/ Contains all packages that make up the parts of ``syncthing``. - auto/ - Auto generated asset data, created by ``genassets`` based on the contents of the ``gui`` directory. - beacon/ Multicast and broadcast UDP beacons. Used by the local discovery system. @@ -108,9 +93,6 @@ lib/ events/ 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. - ignore/ Parses the ``.stignore`` file and matches it against file paths. @@ -120,21 +102,18 @@ lib/ osutil/ Abstracts away certain OS specific quirks. - rc/ - Remote controls a Syncthing process over the REST API. - protocol/ Implementation of the BEP protocol. + rc/ + Remote controls a Syncthing process over the REST API. + scanner/ Looks for changes to files and hashes them as appropriate. stats/ Records statistics about devices and folders. - symlinks/ - Handles symlinks in a platform independent manner. - sync/ Provides optional debugging on top of the regular Mutex / RWMutex primitives. @@ -150,12 +129,6 @@ lib/ man/ Manual pages, generated from the documentation. -pkg/ - Compiled packages, generated by the build process. - -protocol/ - Legacy location of the protocol package. - script/ Various utility scripts for auto generating stuff and so on. From af7eeaf4181dff50513a2d95aa11f030474ee187 Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Sat, 18 May 2024 16:41:13 -0700 Subject: [PATCH 2/4] intro: Add moved programs under /script --- dev/intro.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/dev/intro.rst b/dev/intro.rst index 245401af7..0138bae34 100644 --- a/dev/intro.rst +++ b/dev/intro.rst @@ -132,6 +132,15 @@ man/ script/ Various utility scripts for auto generating stuff and so on. + genassets/ + Generates asset files that are compiled into ``syncthing`` as part of the build process (build utility). + + transifexdl/ + Downloads translations from Transifex (build utility). + + translate/ + Generates translation source for Transifex based on the HTML source (build utility). + test/ The integration test suite. From 17f7cff67ca89b99cb446da73a18318c6cb8247f Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Tue, 12 Nov 2024 22:28:44 -0800 Subject: [PATCH 3/4] Update intro.rst with new dir structure --- dev/intro.rst | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/dev/intro.rst b/dev/intro.rst index 0138bae34..921483e32 100644 --- a/dev/intro.rst +++ b/dev/intro.rst @@ -54,21 +54,33 @@ bin/ cmd/ Commands either built as end products or used by the build process itself. - stcompdirs/ - Compares two directories (debugging utility). + stdiscosrv/ + Global discovery server for the Syncthing project. - stevents/ - Displays event trace from a remote ``syncthing`` using the API (debugging utility). - - stfileinfo/ - Shows information about a file, in the same manner ``syncthing`` would see it (debugging utility). - - stfinddevice/ - Looks up a device on a global discovery server (debugging utility). + strelaysrv/ + Relay server for the Syncthing project. syncthing/ Synchronizes files between devices... + dev/ + Development related utilities. + + stcompdirs/ + Compares two directories (debugging utility). + + stevents/ + Displays event trace from a remote ``syncthing`` using the API (debugging utility). + + stfileinfo/ + Shows information about a file, in the same manner ``syncthing`` would see it (debugging utility). + + stfinddevice/ + Looks up a device on a global discovery server (debugging utility). + + infra/ + Infrastructure related utilities. + etc/ Startup scripts and integration files. Included as-is in the release packages. From a2b10028ccf57912149b84e956289740d7a3e75e Mon Sep 17 00:00:00 2001 From: Ross Smith II Date: Wed, 27 Nov 2024 05:35:14 -0800 Subject: [PATCH 4/4] docs(intro): fix whitespace --- dev/intro.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/intro.rst b/dev/intro.rst index 921483e32..65f40387c 100644 --- a/dev/intro.rst +++ b/dev/intro.rst @@ -144,10 +144,10 @@ man/ script/ Various utility scripts for auto generating stuff and so on. - genassets/ + genassets/ Generates asset files that are compiled into ``syncthing`` as part of the build process (build utility). - transifexdl/ + transifexdl/ Downloads translations from Transifex (build utility). translate/