Loading...
 

Git Tips

View source code:
https://github.com/tikiorg/tiki

For descriptions about each branch, please see: Where to commit for more information.

Technical information

To get stable, development and experimental branches, see: Get code. Also see: Where to commit

First, the reference documentation for git:
https://git-scm.com/documentation

git client version

You should use a recent version.

Basic git usage

Below are basic command lines to know. If you were using GUI like TortoiseCVS, just download TortoiseGit instead ;)

Commands available to anyone on the internet

First you need your own copy of the Tiki repository which will be on branch master (aka trunk) by default.

Fork Tiki
git clone https://github.com/tikiorg/tiki.git
cd tiki

  • To checkout the latest branch 14.x (switches your working directory to branch 14):
Checkout branch 14.x
git checkout 14.x


Similarly to undo your uncommitted changes to a file:

Reset changes to file
git checkout <file>

 Following not finished

The following commands are a copy from the SVN Tips page and need to be adapted still. A git workflow has to be designed before we can do this.

  • To build a new 14.x Tiki (all code without SVN specific files)
svn export https://svn.code.sf.net/p/tikiwiki/code/branches/14.x DEST_DIRECTORY

  • To update a checkout (caution: current version of trunk is experimental)
cd checkout_directory
git pull

  • To update/rollback an installation to a different revision (ahead or back)
svn update -r1234

  • To update/rollback a single file to a different revision (ahead or back)
svn update -r1234 filename.php

  • To update faster (in development, not production environments)
cd checkout_directory
svn up --ignore-externals

  • To see what will be committed
cd checkout_directory
svn status
svn diff

  • To list the content of 14.x branch on the server:
svn ls https://svn.code.sf.net/p/tikiwiki/code/branches/14.x
  • To list the content of development trunk on the server:
svn ls https://svn.code.sf.net/p/tikiwiki/code/trunk

Commands for Tiki developers

  • To commit something inside a checkout

Committing requires a SourceForge login/password. Also, a Tiki admin needs to give you Write permissions. See How to get commit access

cd checkout_directory
svn commit

Please commit with an inline message:

svn commit -m "[FIX] short fix description...."

Your first commit may require your sourceforge login/password

svn commit --username yourlogin -m "[FIX] short fix description...."

  • To see the log of commit messages
cd checkout_directory
svn update #this is to be sure to have the last log entries
svn log

or page by page

svn log |less

View one commit's changes
svn diff -r1234:1235
Rollback one version (e.g. revert changes made in a range of revisions)
svn merge -r1235:1234 .
svn ci
Alternative command to rollback one version (e.g. revert changes made in one revision)
svn merge -c -1235 .
svn ci
View single log entry
svn log -r1234

  • Adding a file to the repository
Add a file
cd checkout_directory
svn add new_file
svn commit -m "[ADD] feature: new file added in order to ....."


Please take care about the svn properties of the files that you add.

  • php, inc, tpl, js, css files should have only one svn property: svn:keywords whose value is "Id" (without double-quotes). Please, see this page. You can add, in the header of these files a commented line
// $Id$

Once committed, this will expand and indicate the last commit on that file

  • png, jpg, all image files : svn:mime-type ==> application/octet-stream. For those files, this prop is automatically added by the server when you commit

Useful tips

Those commands are faster if you use them on one precise directory or file
(e.g. svn log tiki-index.php ; svn diff lib/ ; ...)

Your SourceForge login/password will not be necessary until you commit something.
This means that anonymous and developer access are the same... This is very nice :-)

Note that if you have a message like this one when trying to commit, it means that your password has expired and you need to login through SourceForge's web interface to change it. SourceForge will allow you to login and will not tell you the password is expired. Change it anyway.

svn: Commit failed (details follow): 
svn: MKACTIVITY  of '/svnroot/tikiwiki/!svn/act/eac4ef53-cc7f-4415-ae1e-da1bac94a2ce': 
 authorization failed (https://tikiwiki.svn.sourceforge.net)

MultiTiki

If you use MultiTiki and SVN together (for instance; for local development) then adding this line to your subversion config file

Linux: /etc/subversion/config
Mac OS: ~/.subversion/config

will help keep things tidy for you:
global-ignores = *.com *.org *.net *.local *.whatever
Contributors to this page: amette .
Page last modified on Saturday 27 February, 2016 20:41:07 UTC by amette.

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting 7.x
Administration
Ajax 2.x
Articles & Submissions
Backlinks
Banner
Batch 6.x
BigBlueButton audio/video/chat/screensharing (5.x)
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution 2.x
Cookie
Copyright
Credits 6.x
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs 8.x
DogFood
Draw 7.x
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping 3.x
Mobile Tiki and Voice Tiki
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Payment 5.x
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Score
Search engine optimization (SEO)
Search
Security
Semantic links 3.x
Share
Shopping Cart 5.x
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags 2.x
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests 2.x
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
WebHelp
Webmail and Groupmail
WebServices 3.x
Wiki 3D
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives 4.x
WYSIWTSN 4.x
WYSIWYCA
WYSIWYG 2.x
XMLRPC




Useful Tools