X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/98db544305fb7cc5c91e898cf4f312f98067eed5..b428fb1b14a1a719066a7c7691db778349ee753b:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 213146a7a..6aabf53db 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -41,7 +41,7 @@ In the editor, you could start by entering a simple page like This wiki is powered by [ikiwiki](http://ikiwiki.info). """]] -See [[HelpOnFormatting]] for details about the markup language. +See [[ikiwiki/formatting]] for details about the markup language. Note that several [[standard_wiki_pages|basewiki]] will be added to your wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will @@ -107,56 +107,38 @@ At this point you might want to check your wiki in to a revision control system so you can keep track of changes and revert edits. Depending on the revision control system you choose, the way this is done varies. -There's little that's ikiwiki specific about these instructions; this is -just how you put a directory under revision control using the various -systems that ikiwiki supports. Note that the .ikiwiki subdirectory is -where ikiwiki keeps its state, and should be preserved, but not checked -into revision control. +Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and +should be preserved, but not checked into revision control. + +The new [[ikiwiki-makerepo]] command automates setting up a wiki in +revision control. [[toggle id=subversion text="Subversion"]] [[toggleable id=subversion text=""" REPOSITORY=~/wikirepo - svnadmin create $REPOSITORY - svn mkdir file://$REPOSITORY/trunk -m "create trunk" - cd $SRCDIR - svn co file://$REPOSITORY/trunk . - svn add * - svn commit -m "initial import" + ikiwiki-makerepo svn $SRCDIR $REPOSITORY """]] [[toggle id=git text="Git"]] [[toggleable id=git text=""" -When using Git, you probably want to set up two repositories, of which -one should be bare (meaning that it does not have a working tree -checked out). We call the bare repository the "repository" and the -other will be the "srcdir" (which `ikiwiki` uses to compile the wiki). -There are [other -ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories) -to do the following, but this might be easiest: - REPOSITORY=~/wiki.git - GIT_DIR=$REPOSITORY git --bare init --shared - cd $SRCDIR - git init - echo /.ikiwiki > .gitignore - git add . - git commit -m "initial commit" - git remote add origin $REPOSITORY - git config branch.master.merge refs/heads/master - git push --all - -It is **paramount** that you **never** push to the Git repository in -`$SRCDIR` ([this FAQ entry explains -why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)). -Instead, if you want to work on the wiki from a remote machine, clone -`$REPOSITORY`, using either the `git` transport (if available), or -`ssh`. - -If at any point you commit changes in `$SRCDIR`, make sure to `git -push` them to the `$REPOSITORY`. ikiwiki will do this automatically -for any changes made via the web. - -Finally, see [[Git_pitfalls]] if you experience problems. + ikiwiki-makerepo git $SRCDIR $REPOSITORY + +Please see [[rcs/git]] for detailed documentation about how +ikiwiki uses git repositories, and some important caveats +about using the git repositories. +"""]] + +[[toggle id=mercurial text="Mercurial"]] +[[toggleable id=mercurial text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo mercurial $SRCDIR +"""]] + +[[toggle id=bazaar text="Bazaar"]] +[[toggleable id=bazaar text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo bzr $SRCDIR """]] [[toggle id=tla text="TLA"]] @@ -173,15 +155,6 @@ Finally, see [[Git_pitfalls]] if you experience problems. tla import """]] -[[toggle id=mercurial text="Mercurial"]] -[[toggleable id=mercurial text=""" - REPOSITORY=$SRCDIR - hg init $REPOSITORY - cd $REPOSITORY - hg add * - hg commit -m "initial import" -"""]] - [[toggle id=monotone text="Monotone"]] [[toggleable id=monotone text=""" # These instructions are standard instructions to import a directory into monotone