Skip to content

Commit 13a068a

Browse files
authored
chore(dev): update source code layout in intro (#864)
1 parent 477e559 commit 13a068a

File tree

1 file changed

+33
-39
lines changed

1 file changed

+33
-39
lines changed

dev/intro.rst

Lines changed: 33 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -48,38 +48,38 @@ for the build system. The actual code lives in the ``cmd/syncthing`` and
4848
assets/
4949
Various graphical assets -- the logo.
5050

51+
bin/
52+
Compiled packages, generated by the build process.
53+
5154
cmd/
5255
Commands either built as end products or used by the build process itself.
5356

54-
genassets/
55-
Generates asset files that are compiled into ``syncthing`` as part of the build process (build utility).
57+
stdiscosrv/
58+
Global discovery server for the Syncthing project.
5659

57-
stcompdirs/
58-
Compares two directories (debugging utility).
60+
strelaysrv/
61+
Relay server for the Syncthing project.
5962

60-
stevents/
61-
Displays event trace from a remote ``syncthing`` using the API (debugging utility).
63+
syncthing/
64+
Synchronizes files between devices...
6265

63-
stfileinfo/
64-
Shows information about a file, in the same manner ``syncthing`` would see it (debugging utility).
66+
dev/
67+
Development related utilities.
6568

66-
stfinddevice/
67-
Looks up a device on a global discovery server (debugging utility).
69+
stcompdirs/
70+
Compares two directories (debugging utility).
6871

69-
stindex/
70-
Prints index (database) contents (debugging utility).
72+
stevents/
73+
Displays event trace from a remote ``syncthing`` using the API (debugging utility).
7174

72-
syncthing/
73-
Synchronizes files between devices...
75+
stfileinfo/
76+
Shows information about a file, in the same manner ``syncthing`` would see it (debugging utility).
7477

75-
todos/
76-
Converts line endings from Unix to DOS standard (build utility).
78+
stfinddevice/
79+
Looks up a device on a global discovery server (debugging utility).
7780

78-
transifexdl/
79-
Downloads translations from Transifex (build utility).
80-
81-
translate/
82-
Generates translation source for Transifex based on the HTML source (build utility).
81+
infra/
82+
Infrastructure related utilities.
8383

8484
etc/
8585
Startup scripts and integration files. Included as-is in the release packages.
@@ -90,9 +90,6 @@ gui/
9090
lib/
9191
Contains all packages that make up the parts of ``syncthing``.
9292

93-
auto/
94-
Auto generated asset data, created by ``genassets`` based on the contents of the ``gui`` directory.
95-
9693
beacon/
9794
Multicast and broadcast UDP beacons. Used by the local discovery system.
9895

@@ -108,9 +105,6 @@ lib/
108105
events/
109106
The event subsystem, handles emitting of and subscribing to events across the other packages.
110107

111-
fnmatch/
112-
Matches strings to glob patterns, used by the ignore package.
113-
114108
ignore/
115109
Parses the ``.stignore`` file and matches it against file paths.
116110

@@ -120,21 +114,18 @@ lib/
120114
osutil/
121115
Abstracts away certain OS specific quirks.
122116

123-
rc/
124-
Remote controls a Syncthing process over the REST API.
125-
126117
protocol/
127118
Implementation of the BEP protocol.
128119

120+
rc/
121+
Remote controls a Syncthing process over the REST API.
122+
129123
scanner/
130124
Looks for changes to files and hashes them as appropriate.
131125

132126
stats/
133127
Records statistics about devices and folders.
134128

135-
symlinks/
136-
Handles symlinks in a platform independent manner.
137-
138129
sync/
139130
Provides optional debugging on top of the regular Mutex / RWMutex primitives.
140131

@@ -150,15 +141,18 @@ lib/
150141
man/
151142
Manual pages, generated from the documentation.
152143

153-
pkg/
154-
Compiled packages, generated by the build process.
155-
156-
protocol/
157-
Legacy location of the protocol package.
158-
159144
script/
160145
Various utility scripts for auto generating stuff and so on.
161146

147+
genassets/
148+
Generates asset files that are compiled into ``syncthing`` as part of the build process (build utility).
149+
150+
transifexdl/
151+
Downloads translations from Transifex (build utility).
152+
153+
translate/
154+
Generates translation source for Transifex based on the HTML source (build utility).
155+
162156
test/
163157
The integration test suite.
164158

0 commit comments

Comments
 (0)