Changes between Version 2 and Version 3 of QtWebKitDocContrib


Ignore:
Timestamp:
Jun 22, 2010 4:28:08 AM (11 years ago)
Author:
Henry Haverinen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • QtWebKitDocContrib

    v2 v3  
    1010The C++ API documentation is included in line in the C++ source files. Standalone documentation articles are in the WebKit/qt/docs directory.
    1111
    12 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.
     12== The qdoc tool ==
     13
     14The qdoc markup is a simple wiki-like format. The qdoc tool is documented here: http://qt.gitorious.org/qt/pages/DocManual.
     15
     16For 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.
     17
     18On 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.
     19
     20== Installing git ==
     21
     22In 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].
     23
     24Before 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
     25
     26After installing git, you can verify your installation by typing {{{git}}} on the command line, to see a list of most commonly used git commands.
    1327
    1428== Checking out the sources ==
    1529
    16 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]
    17 hosted at [http://gitorious.org/qtwebkit Gitorious.org]. This is a mirror of the WebKit SVN repository.
     30Since 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:
    1831
    1932{{{
     
    2134}}}
    2235
    23 To see the remote branches you just fetched do:
     36Cloning the repository can take some time, so please be patient.
     37
     38Git 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.
     39
     40If you want to make sure you're using the master branch, you can see the remote branches you just fetched with this command:
    2441{{{
    2542git branch -r
    2643}}}
    2744
    28 For the tags simply do:
    29 {{{
    30 git tag
    31 }}}
    32 
    33 And to switch to a branch or a tag simply use {{{git checkout}}}
     45And to switch to a branch simply use {{{git checkout branchname}}}
    3446
    3547== Submitting a documentation contribution ==
    3648
     49Documentation 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).
     50
    3751When 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.
     52
    3853 * Make your changes in the webkit source code directory. Typically, you would change  existing qdoc files or create new qdoc files.
    3954 * Run the {{{WebKitTools/Scripts/prepare-ChangeLog}}} script to create an entry for your changes in each relevant ChangeLog file.
     
    4863 * Wait :)
    4964
     65== Having your documentation contribution cherry picked to a previous QtWebKit release ==
     66
     67TBD
     68
    5069== Building the documentation articles  ==
    5170