doc:git

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
doc:git [2011/12/07 00:49]
frozenfire Added wrapper repository example, changed externals example to preformatted
doc:git [2020/09/03 01:18] (current)
avenger
Line 16: Line 16:
   - [[https://svn.php.net/viewvc/phpdoc/pt_BR/|Brazilian Portuguese]]   - [[https://svn.php.net/viewvc/phpdoc/pt_BR/|Brazilian Portuguese]]
   - [[https://svn.php.net/viewvc/phpdoc/zh/|Chinese (simplified)]]   - [[https://svn.php.net/viewvc/phpdoc/zh/|Chinese (simplified)]]
 +  - [[https://svn.php.net/viewvc/phpdoc/en/|English]]
   - [[https://svn.php.net/viewvc/phpdoc/fr/|French]]   - [[https://svn.php.net/viewvc/phpdoc/fr/|French]]
   - [[https://svn.php.net/viewvc/phpdoc/de/|German]]   - [[https://svn.php.net/viewvc/phpdoc/de/|German]]
Line 28: Line 29:
  
 == Properties == == Properties ==
 +
 +**svn:externals**
 Modules are achieved using the Subversion property known as svn:externals. This prop allows external Modules are achieved using the Subversion property known as svn:externals. This prop allows external
 Subversion paths to be linked into the project by URL. Subversion paths to be linked into the project by URL.
Line 34: Line 37:
   doc-base https://svn.php.net/repository/phpdoc/doc-base/trunk   doc-base https://svn.php.net/repository/phpdoc/doc-base/trunk
   en https://svn.php.net/repository/phpdoc/en/trunk   en https://svn.php.net/repository/phpdoc/en/trunk
 +
 +**svn:keywords**
 +Each xml file in the repository contains a set of keywords which are automatically substituted when
 +checked out. These allow certain terms to be automatically updated for each commit, rather than
 +maintained manually. Importantly, the Revision keyword allows translations to track what version
 +of the English translation their file is based upon.
 +
 +''svn:keywords Example''
 +  Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
  
 === Proposed Git Structure === === Proposed Git Structure ===
Line 39: Line 51:
 are required for the transition to Git from Subversion. First and foremost, Git does not support are required for the transition to Git from Subversion. First and foremost, Git does not support
 partial check-outs of a subsection of the repository. partial check-outs of a subsection of the repository.
-Because of this, the project much be split into several independent repositories, and "wrapper"+Because of this, the project must be split into several independent repositories, and "wrapper"
 repositories whose function is to define a set of submodules that make up each translation's project. repositories whose function is to define a set of submodules that make up each translation's project.
  
 == Doc-Base == == Doc-Base ==
-Since the doc-base path of the PHP Documentation project is a global dependency for all builds, it makes up its own major project, which all wrapper repositories will include as a submodule.+Since the doc-base path of the PHP Documentation project is a global dependency for all builds, it 
 +makes up its own major project, which all wrapper repositories will include as a submodule.
  
 == "Wrapper" Repositories == == "Wrapper" Repositories ==
Line 50: Line 63:
 ''doc-en Wrapper Repository Example'' ''doc-en Wrapper Repository Example''
   git init phpdoc-en   git init phpdoc-en
-  git submodule add phpdoc-en/doc-base git://github.com/php/phpdoc-base.git +  git submodule add git://github.com/php/doc-base.git phpdoc-en/doc-base 
-  git submodule add phpdoc-en/en git://github.com/php/phpdoc-en.git+  git submodule add git://github.com/php/doc-en.git phpdoc-en/en 
 + 
 +== Attributes == 
 +Because Git does not support keywords in the same way that Subversion does, some changes may need to be 
 +made, or it may be necessary to create hackish dependencies in order to 
 +[[https://github.com/turon/git-rcs-keywords|maintain the current scheme]]. 
 + 
 +''RCS Keywords Example'' 
 +  git clone git://github.com/turon/git-rcs-keywords.git 
 +  git init phpdoc-en 
 +  cat git-rcs-keywords/.gitconfig >> phpdoc-en/.git/config 
 +  echo '*.xml filter=rcs-keywords' >> phpdoc-en/.gitattributes 
 +  cp -R git-rcs-keywords/.git_filters phpdoc-en/
doc/git.1323218976.txt.gz · Last modified: 2017/09/22 13:28 (external edit)