Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup of the root directory of the source code #133

Closed
synctext opened this issue May 8, 2013 · 13 comments
Closed

Cleanup of the root directory of the source code #133

synctext opened this issue May 8, 2013 · 13 comments
Assignees

Comments

@synctext
Copy link
Member

synctext commented May 8, 2013

Problem: too much clutter

keep in root: README.md (and Tribler plus Debian subdirs obviously)
Possible to move .gitignore to both subdirs Tribler and Debian?
Tribler/utilities and Tribler/Tools are confusing.
Perhaps create a cmdline-tools dir and move a lot there?

move all the following root files to a proper subdir:
clean.bat
dispersy-test
dprint.conf
ffmpeg.exe
ldecoder.py
lencoder.py
lucid-xpicreate.sh
makedist.bat
makedistmac.sh
playmakedist.bat
pluginmakedist.bat
pluginmakedist_FX_only.bat
pluginmakedist_IE_only.bat
reset.bat
reset-keepid.bat
runmac.command
swifttest.py
tribler.sh (seems for OSX only?)
vlc-1.0.5-swarmplugin-switch-kcc-src-aug2010-renum110-r16968.patch
xie8transmakedist.bat
xpitransmakedeb.sh
xpitransmakedist.bat
xpitransmakedistmac.sh
xpitransmakedist.sh

@ghost ghost assigned whirm May 8, 2013
@NielsZeilemaker
Copy link

Most files are used for building a version of tribler. FFMpeg is used to determine the bitrate while streaming, we can move it somewhere else if neccesary.

@whirm
Copy link

whirm commented May 14, 2013

what about a scripts/ dir?

@synctext
Copy link
Member Author

A "build-scripts" dir sounds like the natural place for all this. Tribler/utilities and Tribler/Tools are already confusing, hence my "build-scripts" proposal.

@NielsZeilemaker
Copy link

Concerning the cleanup, maybe we can restructure the complete souce code instead.
My proposal of the structure; basically I want to end up with 3 folders: Core, Main, and Communities.

Inside Core, all functionality which can be turned on/off with LaunchManyCore should be moved:

  • Dispersy
  • TorrentChecking (renamed TrackerChecking) + mainlineDhtchecking.py
  • Category
  • Debug (maybe remove this completely if we switch to logging)
  • Policies (maybe rename)
  • Tools (maybe rename)
  • Video
  • Utilities
  • schema_sdb to Core/Sqlitecachedb
  • vlc.py to Core/Video

Removed:

  • UPnP
  • Transport (move to separate swarmplayer project)
  • WebUI (move to separate swarmplayer project)
  • Plugin (move to separate swarmplayer project)
  • Images (move to separate swarmplayer project, copy images used by gui to main folder)
  • Subscriptions
  • Lang
  • ldecoder.py
  • lencoder.py
  • build files? we have to see which are still usefull and move them?

@whirm
Copy link

whirm commented Jun 3, 2013

security wise it would be nice to have an up to date build of the ffmpeg executable too instead of having the windows exe laying there.

@whirm
Copy link

whirm commented Jun 3, 2013

And now that we are at it, we could lowercase all the package names.

@boudewijn-tribler
Copy link

If we move Main/tribler.py (and other used entry python files) into the root directory we would not have to set pythonpath to the current directory (since python sets the cwd to the directory of its entry file, or something along those lines).

I see several things in 'Main', roughly: entry python files, GUI, and build scripts. Can we either choose a more descriptive name to replace 'Main' or move these three distinct things to the same directory level as Core, i.e. remove the 'Main' entirely.

And where would SwiftEngine go in the proposed directory structure? I assume into Core?

@NielsZeilemaker
Copy link

I wouldn't go as far as splitting up the Main folder. However, moving the build scripts to as a toplevel directory makes sense.

As for swift, i'm not so sure. Its more an external reference. You don't need the sources of swift to run tribler, you only need a compiled version of swift. Dispersy is a bit different, you actually need the sources in order to run tribler. Maybe Elric has some idea's about it?

@whirm
Copy link

whirm commented Jun 3, 2013

I would keep both references as they are, it makes it easier for us to control which combination of versions of the code should be used in each branch of Tribler.

Also, we have to take into account that this refactor will break everything. Including unit tests, build scripts, jenkins jobs/experiments...

@NielsZeilemaker
Copy link

So I removed some parts of code which wasn't used by Tribler anymore. Also some files from the root were removed. However, I think we need to move the reset_.bat files to a tools directory, and move the makedist_ files to some build dir.
Whirm, can you have a go a moving those? Moving the makedist* files will break all installer Jenkins projects.

@whirm
Copy link

whirm commented Jan 2, 2014

I've reorganized all the mac and windows build/utility scripts and merged the mac and linux shell scripts used to run the devel version into a single one.
The build jobs have been updated too.
I have to test the merged script on a mac to make sure it still works.

@NielsZeilemaker
Copy link

I'll test a devel build on the testmac tomorrow and let you know.
On Jan 2, 2014 7:28 PM, "Elric Milon" [email protected] wrote:

I've reorganized all the mac and windows build/utility scripts and merged
the mac and linux shell scripts used to run the devel version into a single
one.
The build jobs have been updated too.
I have to test the merged script on a mac to make sure it still works.


Reply to this email directly or view it on GitHubhttps://github.com//issues/133#issuecomment-31472833
.

@whirm
Copy link

whirm commented Apr 28, 2014

I guess this can be considered done, @LipuFei you have been testing the mac build lately, right?

@whirm whirm closed this as completed Jul 8, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

4 participants