Debian Codegraph @

t/expected/padre_development.html

raw
1 <p>
2 [[PageOutline(1-2)]]
3 </p>
4 <h1 id="Developmentingeneral">Development in general</h1>
5 <p>
6 We are using Subversion for version control.
7 The main development of Padre is in the trunk <a class="ext-link" href="http://svn.perlide.org/padre/trunk/Padre"><span class="icon"></span>http://svn.perlide.org/padre/trunk/Padre</a> but there are several
8 additional projects and almost all the plugins of Padre also live in the same repository so the best if you check
9 out the whole trunk <a class="ext-link" href="http://svn.perlide.org/padre/trunk"><span class="icon"></span>http://svn.perlide.org/padre/trunk</a>
10 </p>
11 <pre class="wiki">
12 $ svn co http://svn.perlide.org/padre/trunk padre
13 </pre>
14 <p>
15 Then you can run the standard CPAN module process:
16 </p>
17 <p>
18 Make sure you have all of the needed prerequisites. See <a class="ext-link" href="http://padre.perlide.org/trac/wiki/Download"><span class="icon"></span>http://padre.perlide.org/trac/wiki/Download</a>
19 </p>
20 <pre class="wiki">
21 $ cd padre/Padre
22 $ perl Makefile.PL # which will tell about all the missing dependencies of Padre
23 # this may fail if you don't have Module::Install
24 # if so, start cpan and install it with all its prerequisites
25 $ make
26 $ make test
27 </pre>
28 <p>
29 For a more detailed set of instructions on how to install the dependencies visit the <a class="wiki" href="/wiki/Download">Download</a>
30 </p>
31 <p>
32 Once all the above works well you can launch Padre from the SVN tree by running
33 <tt>
34 $ perl dev
35 </tt>
36 </p>
37 <p>
38 dev has some more parameters you can see by typing
39 <tt>
40 $ perl dev -h
41 </tt>
42 </p>
43 <p>
44 The most important being
45 <tt>
46 $ perl dev -a
47 </tt>
48 that will include the path to all the plugins located in trunk/
49 </p>
50 <h2 id="Coding">Coding</h2>
51 <p>
52 See the <a class="ext-link" href="http://search.cpan.org/dist/Padre/lib/Padre/Manual/Hacking.pod"><span class="icon"></span>http://search.cpan.org/dist/Padre/lib/Padre/Manual/Hacking.pod</a> file for Core Padre development
53 and <a class="ext-link" href="http://search.cpan.org/dist/Padre/lib/Padre/Plugin.pm"><span class="icon"></span>http://search.cpan.org/dist/Padre/lib/Padre/Plugin.pm</a> for Plugin development.
54 </p>
55 <h2 id="Translation">Translation</h2>
56 <p>
57 Translation is basically part of the development effort. For more details please take a look at this page:
58 See <a class="wiki" href="/wiki/[wiki:TranslationIntro]">[wiki:TranslationIntro]</a>
59 </p>
60 <h2 id="Documentation">Documentation</h2>
61 <p>
62 The documentation of Padre is standard POD embedded in the .pm files. If you'd like to
63 improve those you should check out the source code of Padre as described above and send
64 patches or ask for commit bit. The documentation is part of the regular development process.
65 </p>
66 <h2 id="QA/Testing">QA/Testing</h2>
67 <p>
68 Unfortunately Padre has not enough automated test mostly due to the fact that
69 we hardly know how to test GUI applications. The existing tests are located
70 in the standard t/ directory.
71 If you'd like to help in this and if you are on Windows you could take a look at the
72 t/win32/ directory where we have a few tests written using Win32::GUItest.
73 You would be very highly regarded if you improved the test coverage of Padre!!
74 </p>
75 <h2 id="ReleaseManagement">Release Management</h2>
76 <p>
77 See separate page about <a class="wiki" href="/wiki/Release">Release</a>
78 </p>
79 <h1 id="Developmentinabranch">Development in a branch</h1>
80 <p>
81 Most of our development is done on the trunk but occasionally we prefer to make our private corner for experimental changes
82 or changes that might not be stable for some time.
83 Instructions on how to do that:
84 </p>
85 <p>
86 Create a branch and work on it:
87 </p>
88 <p>
89 Assuming you have already checked out <a class="ext-link" href="http://svn.perlide.org/padre/trunk/"><span class="icon"></span>http://svn.perlide.org/padre/trunk/</a> to /path/to/padre
90 </p>
91 <pre class="wiki">
92 $ svn cp http://svn.perlide.org/padre/trunk/Padre http://svn.perlide.org/padre/branches/My-branch -m'some messages'
93 $ cd /path/to/padre/Padre
94 $ svn switch http://svn.perlide.org/padre/branches/My-branch .
95 </pre>
96 <p>
97 If you run
98 <tt>
99 svn st ..
100 </tt>
101 </p>
102 <p>
103 You will see a letter S infront to the Padre directory as that one is switched.
104 </p>
105 <p>
106 Now you can edit, test and commit as usual. Your changes will be committed to the branch.
107 </p>
108 <p>
109 When done and you would like to merge your changes
110 </p>
111 <p>
112 1. Make sure everything is committed
113 </p>
114 <pre class="wiki">
115 $ cd /path/to/padre/Padre
116 $ svn switch http://svn.perlide.org/padre/trunk/Padre
117 $ svn log --stop-on-copy http://svn.perlide.org/padre/branches/My-branch
118 </pre>
119 <p>
120 This will show you the changes you made on the branch. Take the FIRST and LAST revision numbers in this log and
121 use the following command to see the full change you made:
122 <tt>
123 svn diff -rFIRST:LAST <a class="ext-link" href="http://svn.perlide.org/padre/branches/My-branch"><span class="icon"></span>http://svn.perlide.org/padre/branches/My-branch</a>
124 </tt>
125 </p>
126 <p>
127 use the following to merge it back to trunk
128 <tt>
129 svn merge -rFIRST:LAST <a class="ext-link" href="http://svn.perlide.org/padre/branches/My-branch"><span class="icon"></span>http://svn.perlide.org/padre/branches/My-branch</a> .
130 svn commit -m'merged -rFIRST:LAST <a class="ext-link" href="http://svn.perlide.org/padre/branches/My-branch"><span class="icon"></span>http://svn.perlide.org/padre/branches/My-branch</a> '
131 svn rm <a class="ext-link" href="http://svn.perlide.org/padre/branches/My-branch"><span class="icon"></span>http://svn.perlide.org/padre/branches/My-branch</a> -m'My-branch is not needed any more'
132 </tt>
133 </p>
134 <p>
135 If you decided it was a dead-end you can just switch back to trunk and remove the branch.
136 </p>
137 <h2 id="Tickets">Tickets</h2>
138 <p>
139 [[TicketQuery(component=development,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
140 </p>