Skip to content

Commit

Permalink
chore(dev): update source code layout in intro (#864)
Browse files Browse the repository at this point in the history
  • Loading branch information
rasa authored Dec 14, 2024
1 parent 477e559 commit 13a068a
Showing 1 changed file with 33 additions and 39 deletions.
72 changes: 33 additions & 39 deletions dev/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,38 @@ 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).
stdiscosrv/
Global discovery server for the Syncthing project.

stcompdirs/
Compares two directories (debugging utility).
strelaysrv/
Relay server for the Syncthing project.

stevents/
Displays event trace from a remote ``syncthing`` using the API (debugging utility).
syncthing/
Synchronizes files between devices...

stfileinfo/
Shows information about a file, in the same manner ``syncthing`` would see it (debugging utility).
dev/
Development related utilities.

stfinddevice/
Looks up a device on a global discovery server (debugging utility).
stcompdirs/
Compares two directories (debugging utility).

stindex/
Prints index (database) contents (debugging utility).
stevents/
Displays event trace from a remote ``syncthing`` using the API (debugging utility).

syncthing/
Synchronizes files between devices...
stfileinfo/
Shows information about a file, in the same manner ``syncthing`` would see it (debugging utility).

todos/
Converts line endings from Unix to DOS standard (build utility).
stfinddevice/
Looks up a device on a global discovery server (debugging utility).

transifexdl/
Downloads translations from Transifex (build utility).

translate/
Generates translation source for Transifex based on the HTML source (build utility).
infra/
Infrastructure related utilities.

etc/
Startup scripts and integration files. Included as-is in the release packages.
Expand All @@ -90,9 +90,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.

Expand All @@ -108,9 +105,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.

Expand All @@ -120,21 +114,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.

Expand All @@ -150,15 +141,18 @@ 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.

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.

Expand Down

0 comments on commit 13a068a

Please sign in to comment.