Skip to content

Commit d6cb997

Browse files
kyngchaoskyngchaos
committedMay 29, 2011
sync OS X doc updates and cleanup from release 1.7
·
ltr-3_40Before-merge-new_vector_api
1 parent fa4d167 commit d6cb997

File tree

4 files changed

+123
-33
lines changed

4 files changed

+123
-33
lines changed
 

‎CODING

Lines changed: 70 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,23 @@ Developers guide for QGIS
3434
1.9.5. Use Braces Even for Single Line Statements
3535
1.9.6. Book recommendations
3636
2. GIT Access
37-
2.1. Accessing the Repository
38-
2.2. Check out a branch
39-
2.3. QGIS documentation sources
40-
2.4. GIT Documentation
41-
2.5. Development in branches
42-
2.5.1. Purpose
43-
2.5.2. Procedure
44-
2.6. Submitting Patches
45-
2.6.1. Patch file naming
46-
2.6.2. Create your patch in the top level QGIS source dir
47-
2.6.3. Getting your patch noticed
48-
2.6.4. Due Diligence
49-
2.7. Obtaining GIT Write Access
37+
2.1. Installation
38+
2.1.1. Install git for GNU/Linux
39+
2.1.2. Install git for Windows
40+
2.1.3. Install git for OSX
41+
2.2. Accessing the Repository
42+
2.3. Check out a branch
43+
2.4. QGIS documentation sources
44+
2.5. GIT Documentation
45+
2.6. Development in branches
46+
2.6.1. Purpose
47+
2.6.2. Procedure
48+
2.7. Submitting Patches
49+
2.7.1. Patch file naming
50+
2.7.2. Create your patch in the top level QGIS source dir
51+
2.7.3. Getting your patch noticed
52+
2.7.4. Due Diligence
53+
2.8. Obtaining GIT Write Access
5054
3. Unit Testing
5155
3.1. The QGIS testing framework - an overview
5256
3.2. Creating a unit test
@@ -415,22 +419,61 @@ http://doc.trolltech.com/qq/qq13-apis.html designing Qt style (APIs)
415419
2. GIT Access
416420
=============
417421

418-
This section describes how to get started using the QGIS GIT repository. Before you can do this, you need to first have a git client installed on your system. Debian based distro users can do:
422+
This section describes how to get started using the QGIS GIT repository. Before you can do this, you need to first have a git client installed on your system.
423+
424+
425+
2.1. Installation
426+
=================
427+
428+
429+
2.1.1. Install git for GNU/Linux
430+
================================
431+
432+
Debian based distro users can do:
419433

420434
sudo apt-get install git
421435

436+
437+
2.1.2. Install git for Windows
438+
==============================
439+
422440
Windows users can obtain msys git (http://code.google.com/p/msysgit/).
423441

424442

425-
2.1. Accessing the Repository
443+
2.1.3. Install git for OSX
444+
==========================
445+
446+
The git (http://git-scm.com/) project has a downloadable build of git.
447+
Make sure to get the package matching your processor (x86_64 most likely, only the first Intel Macs need the i386 package).
448+
449+
Once downloaded open the disk image and run the installer.
450+
451+
PPC/source note
452+
453+
The git site does not offer PPC builds. If you need a PPC build, or you just want
454+
a little more control over the installation, you need to compile it yourself.
455+
456+
Download the source from http://git-scm.com/. Unzip it, and in a Terminal cd to the source folder, then:
457+
458+
make prefix=/usr/local
459+
sudo make prefix=/usr/local install
460+
461+
If you don't need any of the extras, Perl, Python or TclTk (GUI), you can disable them before running make with:
462+
463+
export NO_PERL=
464+
export NO_TCLTK=
465+
export NO_PYTHON=
466+
467+
468+
2.2. Accessing the Repository
426469
=============================
427470

428471
To clone QGIS master:
429472

430473
git://github.com/qgis/Quantum-GIS.git
431474

432475

433-
2.2. Check out a branch
476+
2.3. Check out a branch
434477
=======================
435478

436479
To check out a branch, for example the release 1.7.0 branch do:
@@ -455,7 +498,7 @@ See the INSTALL file in the source tree for specific instructions on building
455498
development versions.
456499

457500

458-
2.3. QGIS documentation sources
501+
2.4. QGIS documentation sources
459502
===============================
460503

461504
If you're interested in checking out Quantum GIS documentation sources:
@@ -467,7 +510,7 @@ If you're interested in checking out Quantum GIS documentation sources:
467510
You can also take a look at DocumentationWritersCorner for more information.
468511

469512

470-
2.4. GIT Documentation
513+
2.5. GIT Documentation
471514
======================
472515

473516
See the following sites for information on becoming a GIT master.
@@ -477,11 +520,11 @@ http://progit.org
477520
http://gitready.com
478521

479522

480-
2.5. Development in branches
523+
2.6. Development in branches
481524
============================
482525

483526

484-
2.5.1. Purpose
527+
2.6.1. Purpose
485528
==============
486529

487530
The complexity of the QGIS source code has increased considerably during the
@@ -495,7 +538,7 @@ This section describes the procedure for branching and merging in the QGIS
495538
project.
496539

497540

498-
2.5.2. Procedure
541+
2.6.2. Procedure
499542
================
500543

501544
- Initial announcement on mailing list:
@@ -541,14 +584,14 @@ Component will be opened to file tickets against. Once there are no remaining
541584
issues left, the technical advisor of the PSC merges the changes into master.
542585

543586

544-
2.6. Submitting Patches
587+
2.7. Submitting Patches
545588
=======================
546589

547590
There are a few guidelines that will help you to get your patches into QGIS
548591
easily, and help us deal with the patches that are sent to use easily.
549592

550593

551-
2.6.1. Patch file naming
594+
2.7.1. Patch file naming
552595
========================
553596

554597
If the patch is a fix for a specific bug, please name the file with the bug
@@ -559,7 +602,7 @@ If the bug is an enhancement or new feature, its usually a good idea to create
559602
a ticket in trac (https://trac.osgeo.org/qgis/) first and then attach you
560603

561604

562-
2.6.2. Create your patch in the top level QGIS source dir
605+
2.7.2. Create your patch in the top level QGIS source dir
563606
=========================================================
564607

565608
This makes it easier for us to apply the patches since we don't need to
@@ -580,7 +623,7 @@ and then generate a patch which contains the delta between your feature branch
580623
and what is in the master branch.
581624

582625

583-
2.6.3. Getting your patch noticed
626+
2.7.3. Getting your patch noticed
584627
=================================
585628

586629
QGIS developers are busy folk. We do scan the incoming patches on bug reports
@@ -591,7 +634,7 @@ can escalate your query to one of the Project Steering Committee members
591634
(contact details also available on the Project Organigram).
592635

593636

594-
2.6.4. Due Diligence
637+
2.7.4. Due Diligence
595638
====================
596639

597640
QGIS is licensed under the GPL. You should make every effort to ensure you only
@@ -600,7 +643,7 @@ rights. Also do not submit code that you are not happy to have made available
600643
under the GPL.
601644

602645

603-
2.7. Obtaining GIT Write Access
646+
2.8. Obtaining GIT Write Access
604647
===============================
605648

606649
Write access to QGIS source tree is by invitation. Typically when a person

‎doc/CODING.t2t

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,14 +407,48 @@ You should also really read this article from Qt Quarterly on
407407

408408
= GIT Access =
409409

410-
This section describes how to get started using the QGIS GIT repository. Before you can do this, you need to first have a git client installed on your system. Debian based distro users can do:
410+
This section describes how to get started using the QGIS GIT repository. Before you can do this, you need to first have a git client installed on your system.
411+
412+
== Installation ==
413+
414+
=== Install git for GNU/Linux ===
415+
416+
Debian based distro users can do:
411417

412418
```
413419
sudo apt-get install git
414420
```
415421

422+
=== Install git for Windows ===
423+
416424
Windows users can obtain [msys git http://code.google.com/p/msysgit/].
417425

426+
=== Install git for OSX ===
427+
428+
The [git http://git-scm.com/] project has a downloadable build of git.
429+
Make sure to get the package matching your processor (x86_64 most likely, only the first Intel Macs need the i386 package).
430+
431+
Once downloaded open the disk image and run the installer.
432+
433+
__PPC/source note__
434+
435+
The git site does not offer PPC builds. If you need a PPC build, or you just want
436+
a little more control over the installation, you need to compile it yourself.
437+
438+
Download the source from http://git-scm.com/. Unzip it, and in a Terminal cd to the source folder, then:
439+
440+
```
441+
make prefix=/usr/local
442+
sudo make prefix=/usr/local install
443+
```
444+
445+
If you don't need any of the extras, Perl, Python or TclTk (GUI), you can disable them before running make with:
446+
447+
```
448+
export NO_PERL=
449+
export NO_TCLTK=
450+
export NO_PYTHON=
451+
```
418452

419453

420454
== Accessing the Repository ==

‎doc/INSTALL.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ <H3>Sunday May 29, 2011</H3>
8181
<LI><A HREF="#toc18">5.1. Install Qt4 from disk image</A>
8282
<LI><A HREF="#toc19">5.2. Install development frameworks for QGIS dependencies</A>
8383
<LI><A HREF="#toc20">5.3. Install CMake for OSX</A>
84-
<LI><A HREF="#toc21">5.4. Download QGIS source from github</A>
84+
<LI><A HREF="#toc21">5.4. QGIS source</A>
8585
<LI><A HREF="#toc22">5.5. Configure the build</A>
8686
<LI><A HREF="#toc23">5.6. Building</A>
8787
</UL>
@@ -2100,10 +2100,17 @@ <H2>5.3. Install CMake for OSX</H2>
21002100
</PRE></div>
21012101

21022102
<A NAME="toc21"></A>
2103-
<H2>5.4. Download QGIS source from github</H2>
2103+
<H2>5.4. QGIS source</H2>
21042104

21052105
<P>
2106-
Go to the github QGIS project page:
2106+
Unzip the QGIS source tarball to a working folder of your choice
2107+
(/usr/somewhere is not a good choice as it's hidden and requires root
2108+
privileges). If you are reading this from the source, you've already done
2109+
this.
2110+
</P>
2111+
<P>
2112+
If you want to experiment with the latest development sources, go to the github
2113+
QGIS project page:
21072114
</P>
21082115
<P>
21092116
<A HREF="http://github.com/qgis/Quantum-GIS">http://github.com/qgis/Quantum-GIS</A>

‎doc/osx.t2t

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,9 +355,15 @@ make
355355
sudo make install
356356
```
357357

358-
== Download QGIS source from github ==
358+
== QGIS source ==
359359

360-
Go to the github QGIS project page:
360+
Unzip the QGIS source tarball to a working folder of your choice
361+
(/usr/somewhere is not a good choice as it's hidden and requires root
362+
privileges). If you are reading this from the source, you've already done
363+
this.
364+
365+
If you want to experiment with the latest development sources, go to the github
366+
QGIS project page:
361367

362368
http://github.com/qgis/Quantum-GIS
363369

0 commit comments

Comments
 (0)
Please sign in to comment.