Difference between revisions of "Hacker Guide/VLC source tree"

From VideoLAN Wiki
Jump to navigation Jump to search
m
Line 4: Line 4:
 
'''Why Does This Page Exist?
 
'''Why Does This Page Exist?
 
Well, simply because VLC has evolved with not so much accumulation in mind, and when a new coder looks at the code, s/he is terrified by the abundance of directories.
 
Well, simply because VLC has evolved with not so much accumulation in mind, and when a new coder looks at the code, s/he is terrified by the abundance of directories.
If some could explain why, for example, activex is not in the bindings folder, why there is a separate python directory at the root, what several directories like evc, lxdialog are, that would be great! Please remove this paragraph when done.'''
+
If some could explain why, for example, activex is not in the bindings folder, why there is a separate python directory at the root, what several directories like evc, lxdialog are, that would be great! Note that I have added a FIXME! at the beginning of the explanation of those directories.  Please remove this paragraph when done.'''
  
 
The directories are listed in alphabetical order, with an overview of their contents on the right.
 
The directories are listed in alphabetical order, with an overview of their contents on the right.
Line 23: Line 23:
 
|-
 
|-
 
|evc                
 
|evc                
|[color="red"]I don't know. Please fill this.
+
|FIX ME! I don't know. Please fill this.
 
|-
 
|-
 
|extras -
 
|extras -
Line 33: Line 33:
 
|-
 
|-
 
|ipkg                
 
|ipkg                
|I guess this is not so important, last modified 2 years ago!
+
|FIX ME! I guess this is not so important, last modified 2 years ago!
 
|-
 
|-
 
|libs                
 
|libs                
|Loader and secure rtp libraries
+
|FIX ME! Loader and secure rtp libraries
 
|-
 
|-
 
|lxdialog                
 
|lxdialog                
|I guess this is not important, last modified 1 year ago!
+
|FIX ME! I guess this is not important, last modified 1 year ago!
 
|-
 
|-
 
|m4                
 
|m4                
Line 57: Line 57:
 
|-
 
|-
 
|python
 
|python
|not important
+
|FIX ME! not important
 
|-
 
|-
 
|share
 
|share

Revision as of 17:02, 2 April 2007

Help VideoLAN by adding to this page!
Create an account to start editing, and then click here to add to this article.

This page lists the directories in the source tree of VLC, aimed at giving new beginners an overview of the code.

Why Does This Page Exist? Well, simply because VLC has evolved with not so much accumulation in mind, and when a new coder looks at the code, s/he is terrified by the abundance of directories. If some could explain why, for example, activex is not in the bindings folder, why there is a separate python directory at the root, what several directories like evc, lxdialog are, that would be great! Note that I have added a FIXME! at the beginning of the explanation of those directories. Please remove this paragraph when done.

The directories are listed in alphabetical order, with an overview of their contents on the right.

Directory Name Directory Explanation
activex activex bindings
bindings Java and Python bindings
doc Documentation (not up-to-date)
evc FIX ME! I don't know. Please fill this.
extras - contrib (subdirectory of extras) - for required libraries (contains Makefiles to automatically download and compile (or cross-compile) and patch those. Please first attempt to get the development headers precompiled for your distribution.

extras also contains the emacs.init file (useful for coding in Videolan style)

include Header files for vlc
ipkg FIX ME! I guess this is not so important, last modified 2 years ago!
libs FIX ME! Loader and secure rtp libraries
lxdialog FIX ME! I guess this is not important, last modified 1 year ago!
m4 Macro files needed for ???
modules most important directory --todo
mozilla Mozilla plugin
msvc Deprecated, Microsoft Visual C files I guess
po i18n files
python FIX ME! not important
share icons,scripts to make VLC the default player etc.
src to-do
test scripts to see if everything is OK