Difference between revisions of "Developer Documentation"

(VFS)
(use include for Samba codebase organization)
 
(28 intermediate revisions by 6 users not shown)
Line 6: Line 6:
  
 
* [[CodeReview|Doing code review]]
 
* [[CodeReview|Doing code review]]
 
* [[Using_Git_for_Samba_Development|Using Git for Samba Development]]
 
  
 
* [[ActiveProjects|Active projects]]
 
* [[ActiveProjects|Active projects]]
 
  
  
 
= Release planning =
 
= Release planning =
  
* [[Samba_Release_Planning|Samba release planning]]
+
* [[Samba_Release_Planning|Samba release planning]] (including the [[Samba_Release_Planning#Release_Branch_Checkin_Procedure| Policy and steps required for checkins to branches]])
 
 
* [[Branch_Policy|Policy on checkins to branches]]
 
  
 
* [[Samba_Features_added/changed_(by_release)|Samba Features added/changed (by release)]]
 
* [[Samba_Features_added/changed_(by_release)|Samba Features added/changed (by release)]]
Line 24: Line 19:
  
  
 +
= Source code =
  
= Source code =
+
Samba development is stored in the [https://www.git-scm.com/ Git] SCM system.  See [[Using Git for Samba Development]] for more detail on how Samba uses Git.
  
* GitWeb
+
Two web interfaces are:
 +
* [https://git.samba.org/?p=samba.git;a=heads Samba's own GitWeb] ([https://git.samba.org/?p=samba.git;a=shortlog;h=refs/heads/master latest changes in the master branch])
 +
* [https://github.com/samba-team/samba Official Samba GitHub Mirror]
  
:* [http://gitweb.samba.org/?p=samba.git;a=shortlog;h=v4-0-test v4-0-test] (branch for next 4.0.x release)
+
== Samba codebase organization ==
  
:* [http://gitweb.samba.org/?p=samba.git;a=shortlog;h=v4-0-stable v4-0-stable] (branch for current 4.0.x release)
+
{{:Samba codebase organization overview}}
  
:* [http://gitweb.samba.org/?p=samba.git;a=shortlog;h=master master] (current Samba development for future releases)
+
The Samba codebase is broken down in detail in the '''[[Samba_codebase_organization|Samba codebase organization page]]'''.
  
: For more info on available branches, as well how to obtain the sources via a Git client, see the [http://www.samba.org/samba/devel samba.org devel page].
+
= Debugging / Testing =
  
 +
* [[The_Samba_Selftest_System|The Samba Selftest System]]
  
 +
* [[Samba CI on gitlab]]
  
= Debugging / Testing =
+
== [[Writing_Tests|Writing and running Samba tests]]==
  
 
* [[Writing_Torture_Tests|Writing Torture Tests]]
 
* [[Writing_Torture_Tests|Writing Torture Tests]]
 +
 +
* [[Writing_Python_Tests|Writing Python Tests]]
 +
 +
* [[Writing_cmocka_Tests|Writing cmocka Tests]]
 +
 +
* [[Writing_Shell_Tests|Writing Shell Tests]]
 +
 +
* [[Writing_Perl_Tests|Writing Perl Tests]]
  
 
* [[WinTest|Testing against Windows using WinTest]]
 
* [[WinTest|Testing against Windows using WinTest]]
  
* [[Testing_development_trees|Testing development trees]]
+
* [[Understanding_make_test|Understanding make test]]
  
* [[Debugging_individual_tests|Debugging individual tests]]
+
== Debugging help ==
  
 
* [[Keytab_Extraction|Keytab extraction]]
 
* [[Keytab_Extraction|Keytab extraction]]
Line 56: Line 64:
  
 
* [[Saving_RPC_FAULTs|Saving packets that failed to parse to test IDL fixes using ndrdump]]
 
* [[Saving_RPC_FAULTs|Saving packets that failed to parse to test IDL fixes using ndrdump]]
 +
 +
* [[Python/Debugging|Debugging in Python]]
 +
 +
== Development testing ==
 +
 +
* [[Testing removal of ifdef or configure checks|Testing removal of #ifdef or configure checks]]
 +
* [[Fuzzing|Information on Samba's fuzzing infrastructure]]
  
 
= Bug reporting =  
 
= Bug reporting =  
Line 64: Line 79:
  
  
 +
= Security =
 +
 +
* [[Samba_Security_Documentation|Samba Security Documentation]]
 +
* [[Samba_Protocol_Security|Samba Protocol Security Layers]]
  
 
= Presentations =
 
= Presentations =
Line 77: Line 96:
 
* [[Writing a Samba VFS Module]] (for Samba 4.0 and above)
 
* [[Writing a Samba VFS Module]] (for Samba 4.0 and above)
  
= Clustered Samba =
 
  
* [[Clustered_Samba|Clustered Samba]]
 
  
* [[CTDB_Project|CTDB Project]]
+
= Clustered Samba =
  
 +
* [[CTDB_and_Clustered_Samba|CTDB and Clustered Samba]]
  
 +
* [[New_clustering_features_in_SMB3_and_Samba|New clustering features in SMB3 and Samba]]
  
 
= Building Samba =
 
= Building Samba =
Line 126: Line 145:
  
 
* [[Samba4/ActiveDirectory|Active Directory Plans]]
 
* [[Samba4/ActiveDirectory|Active Directory Plans]]
 
* [[Samba4/LDAP_Backend|LDAP Directory Server Backend History Notes]]
 
  
 
* [[Samba4 AD Plugfest 2010 TODO list|Samba 4 AD Plugfest 2010 TODO List]]
 
* [[Samba4 AD Plugfest 2010 TODO list|Samba 4 AD Plugfest 2010 TODO List]]
  
 
* [http://download.samba.org/pub/samba/rc/ Development Releases of Samba4 (technology previews, alphas, betas, release candidates)]
 
* [http://download.samba.org/pub/samba/rc/ Development Releases of Samba4 (technology previews, alphas, betas, release candidates)]
 +
 +
= Academic Writings etc. =
 +
 +
* [https://www.samba.org/samba/news/articles/gensec-white-paper.pdf GENSEC white paper (2005)]
 +
 +
* [https://www.samba.org/samba/news/articles/abartlet_thesis.pdf Thesis on Samba (2005)]
 +
 +
* [https://www.samba.org/~metze/presentations/2007/thesis/StefanMetzmacher_Bachelorthesis_ENG_Draft-9811557.pdf Thesis on Samba replication (2007)]
 +
 +
* [https://www.samba.org/samba/news/articles/samba3-4_integration.pdf Integration of Samba 3 & Samba 4 (2005)]
 +
 +
* [http://is.muni.cz/th/359290/fi_b/thesis.pdf Thesis on Talloc (2012)]

Latest revision as of 22:02, 12 June 2020

How can I contribute


Release planning


Source code

Samba development is stored in the Git SCM system. See Using Git for Samba Development for more detail on how Samba uses Git.

Two web interfaces are:

Samba codebase organization

Broadly speaking, the Samba source-code tree can be organized into the following major groups:

  • Top-level libraries, which contains common code shared amongst the Samba processes.
  • Source3, which is code primarily used by the file server and domain member.
  • Source4, which is code primarily used by the Active Directory Domain Controller.
  • Infrastructure components, which provide the build and test framework for Samba.
  • Autogenerated code, which is used for parsing DCE/RPC packets as well as other regularly structured buffers.

The Samba codebase is broken down in detail in the Samba codebase organization page.

Debugging / Testing

Writing and running Samba tests

Debugging help

Development testing

Bug reporting


Security

Presentations


VFS


Clustered Samba

Building Samba


Building packages


Google Summer of Code


Historical Documentation on the Development of Samba4

  • Franky: A Hybrid Samba Active Directory Controller (outdated!)

Academic Writings etc.