Changes between Version 2 and Version 3 of QtWebKitDocContrib

Timestamp:

Jun 22, 2010, 4:28:08 AM (14 years ago)

Author:

Henry Haverinen

Comment:

--

QtWebKitDocContrib

@@ -10 +10 @@
 The C++ API documentation is included in line in the C++ source files. Standalone documentation articles are in the WebKit/qt/docs directory. 
 
-The qdoc markup is a simple wiki-like format. The qdoc tool is documented here: http://qt.gitorious.org/qt/pages/DocManual. For Windows users, the easiest way to get the qdoc3 command line tool is to install the Qt SDK for Windows and add the bin directory to the PATH. 
+== The qdoc tool ==
+
+The qdoc markup is a simple wiki-like format. The qdoc tool is documented here: http://qt.gitorious.org/qt/pages/DocManual. 
+
+For Windows users, the easiest way to get the qdoc3 command line tool is to install the Qt SDK for Windows and add the bin directory to the PATH. 
+
+On Mac OS X, the qdoc3 binary has not been previously included in the Qt SDK, but as of Qt 4.7 Beta II (to be released soon at the time of writing), the qdoc3 binary is included in the Qt SDK. After installation, qdoc3 should already be in the PATH.
+
+== Installing git ==
+
+In this wiki, we describe how to work with the git version control system and the mirror of the WebKit SVN repository hosted at [http://gitorious.org/webkit Gitorious.org]. 
+
+Before you can use Gitorious.org, you need to install git on your computer. Here are some instructions for git installation on different platforms: http://help.github.com/git-installation-redirect
+
+After installing git, you can verify your installation by typing {{{git}}} on the command line, to see a list of most commonly used git commands.
 
 == Checking out the sources ==
 
-Since the documentation is stored together with the source code, also technical writes need to check out the sources. In this wiki, we describe how to do this using the [http://gitorious.org/qtwebkit public git repository]
-hosted at [http://gitorious.org/qtwebkit Gitorious.org]. This is a mirror of the WebKit SVN repository.
+Since the documentation is stored together with the source code, also technical writes need to check out the sources. Open a command prompt, go to your working directory for QtWebKit documentation, and type the following command:
 
 {{{
@@ -21 +34 @@
 }}}
 
-To see the remote branches you just fetched do:
+Cloning the repository can take some time, so please be patient. 
+
+Git repositories can have several branches. However, by default you should have the master branch of this repository checked out, which works fine for contributing documentation to QtWebKit. 
+
+If you want to make sure you're using the master branch, you can see the remote branches you just fetched with this command:
 {{{
 git branch -r
 }}}
 
-For the tags simply do:
-{{{
-git tag
-}}}
-
-And to switch to a branch or a tag simply use {{{git checkout}}}
+And to switch to a branch simply use {{{git checkout branchname}}}
 
 == Submitting a documentation contribution ==
 
+Documentation is contributed to the WebKit SVN (the trunk of the project). By default, the documentation change will then be included in the next QtWebKit release that is branched off from the trunk. It is also possible to "cherry-pick" documentation changes to previous versions of QtWebKit (see below). 
+
 When using the git repository to access the sources, the steps to submit a patch are roughly as follows. Please see the WebKit project's page about [http://webkit.org/coding/contributing.html contributing] for more information.
+
  * Make your changes in the webkit source code directory. Typically, you would change  existing qdoc files or create new qdoc files. 
  * Run the {{{WebKitTools/Scripts/prepare-ChangeLog}}} script to create an entry for your changes in each relevant ChangeLog file.
@@ -48 +63 @@
  * Wait :)
 
+== Having your documentation contribution cherry picked to a previous QtWebKit release ==
+
+TBD
+
 == Building the documentation articles  ==