Source Code Layout section outdated

Open
#479 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Start with the "Source Code Layout" section linked in the issue and compare its tool lists with the current contents of cmd/. Remove entries that no longer exist and document the listed cmd/ tools that are missing; done means the section matches the repository layout.

Written by the indexing model from the issue text.

Description

I was curious what the purpose of all the different tools in cmd/ is, so I went to the documentation to find an explanation. I found the "Source Code Layout" section, but it seems to be quite outdated.

These tools are mentioned in the documentation, but do not exist anymore:

  • genassets
  • todos
  • transifexdl
  • translate

Thes tools exist in cmd/, but are not mentioned in the documentation:

  • stcli
  • stcrashreceiver
  • stdisco
  • stdiscosrv
  • stfindignored
  • stgenfiles
  • strelaypoolsrv
  • strelaysrv
  • stsigtool
  • stupgrades
  • stvanity
  • stwatchfile
  • uraggregate
  • ursrv
Dominant language
Python
Stars
327
Forks
653
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from syncthing/docs

All issues in syncthing/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.