Skip to content

Commit

Permalink
Merge remote branch 'origin/leto/git_docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
leto committed Nov 8, 2010
2 parents 3fd70ea + 15398a7 commit 8beef6b
Show file tree
Hide file tree
Showing 20 changed files with 424 additions and 229 deletions.
1 change: 0 additions & 1 deletion MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,6 @@ editor/pasm.vim []
editor/pir-mode.el []
editor/pir_vim.in []
editor/pmc.vim []
editor/subversion_config []
examples/README [examples]
examples/benchmarks/addit.pasm [examples]
examples/benchmarks/addit.pir [examples]
Expand Down
2 changes: 1 addition & 1 deletion RESPONSIBLE_PARTIES
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This is a list of project roles, with a partial list of the folks who have
taken responsibility for them. This does not list all the people with
SVN commit access, just those who have a role they've taken responsibility
commit access, just those who have a role they've taken responsibility
for.

See docs/project/roles_responsibilities.pod for role definitions, and
Expand Down
8 changes: 4 additions & 4 deletions docs/book/draft/appb_patch_submission.pod
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ committers and testers have a better idea about what it does. The body of
your email should also include a good description about what you changed
and why.

It's important that you create your patches from a checked-out subversion
It's important that you create your patches from the Parrot git
repository, not from a tarball or a snapshot. This way, you can ensure
that your diff is made against the latest version of the files. If you patch
an old version, the problem may have already been resolved! Make sure
the paths listed in the patch match those in the repository. There are two
methods of creating patches that will do this for you. You can make changes
directly in your checked-out copy of the subversion repository and
then create diffs using the command C<svn diff>. Alternatively, you can
directly in your clone of the git repository and
then create diffs using the command C<git diff>. Alternatively, you can
make a copy of the repository and then create diffs between the two
copies with the C<diff -u> command:

Expand Down Expand Up @@ -81,7 +81,7 @@ message should clearly explain what the patch is supposed to do and
why you're submitting it. Make a note if you're adding or deleting
files so they won't be missed.

Here is a good example of a patch submission using the subversion diff
Here is a good example of a patch submission using the git diff
method (an actual patch from p2). It's short, sticks to the point, and
clearly expresses the problem and the solution. The patch filename and
the subject of the message are both descriptive:
Expand Down
8 changes: 4 additions & 4 deletions docs/book/draft/appd_build_options.pod
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ will typically have access to the C<make> command as part of the normal
development tools. Windows systems can get the C<nmake> utility to perform the
same task.

=item * Subversion
=item * Git

Subversion is the source control system that is used by the Parrot project.
You need subversion to checkout the latest version of the source code. You can
get subversion at L<http://subversion.tigris.org>, or through one of the
Git is the source control system that is used by the Parrot project.
You need git to clone the latest version of the source code. You can
get git at L<http://git-scm.com>, or through one of the
common packaging systems.

=item * bison and flex
Expand Down
10 changes: 5 additions & 5 deletions docs/book/draft/appe_source_code.pod
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ platforms, including Windows, Debian, and Redhat. Point releases are
available from U<http://www.parrot.org/download>.

If you plan to get involved in development, you'll want to check out
the source from the subversion repository directly. Anyone can get
the source from the git repository directly. Anyone can get
anonymous access to read the files and download a working copy to
explore and test. For commit access, volunteers need a
U<https://trac.parrot.org> username, and need to be approved by a
Metacommitter. To download the most recent version from SVN, type this
Metacommitter. To download the most recent version from git, type this
command into your terminal N<This is for Linux users, on Mac or
Windows systems, follow the instructions from your SVN client>:
Windows systems, follow the instructions from your git client>:

svn co https://svn.parrot.org/parrot/trunk parrot
git clone http://github.com/parrot/parrot

There's also a web interface for viewing files in the repository at
U<http://svn.parrot.org/parrot/>.
the same link.

The repository is large and complex, so it's worth taking a little bit
of time to explore. The code changes constantly, but most files and
Expand Down
2 changes: 1 addition & 1 deletion docs/book/draft/ch01_introduction.pod
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ X<metacommitter role>

Metacommitters manage commit access to the Parrot repository. Once a
contributor is selected for commit access, a metacommitter gives the new
committer access to the SVN repository and the bugtracker. The architect is a
committer access to the repository and the bugtracker. The architect is a
metacommitter, but other team members also hold this role.

=item Committer
Expand Down
2 changes: 1 addition & 1 deletion docs/book/pct/ch01_introduction.pod
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ X<metacommitter role>

Metacommitters manage commit access to the Parrot repository. Once a
contributor is selected for commit access, a metacommitter gives the new
committer access to the SVN repository and the bugtracker. The architect is a
committer access to the repository and the bugtracker. The architect is a
metacommitter, but other team members also hold this role.

=item Committer
Expand Down
28 changes: 6 additions & 22 deletions docs/gettingstarted.pod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (C) 2001-2009, Parrot Foundation.
# Copyright (C) 2001-2010, Parrot Foundation.
# $Id$

=head1 NAME
Expand All @@ -22,10 +22,10 @@ L<https://trac.parrot.org/parrot/wiki/NewParrotDeveloperGuide>.

=item *

There is a web interface to the subversion repository, in case you just want to
There is a web interface to the git repository, in case you just want to
browse the source.

L<https://trac.parrot.org/parrot/browser>
L<http://github.com/parrot/parrot>

=item *

Expand All @@ -36,16 +36,10 @@ L<http://www.parrot.org/release/current>

=item *

An even better option is to use SVN, which gets you the very latest copy of the
An even better option is to use git, which gets you the very latest copy of the
Parrot distribution. The procedure for this is:

svn checkout https://svn.parrot.org/parrot/trunk parrot

=item *

If you're using git-svn, you should check out just the latest version. First:

C<< git svn clone -s -r HEAD https://svn.parrot.org/parrot >>
git clone http://github.com/parrot/parrot

=back

Expand All @@ -64,7 +58,7 @@ some reasonable form of C<make>. To do this, follow these three easy steps.

=item 1

C<cd> to your parrot directory and run C<Configure.pl> to create the makefile
C<cd> to your parrot directory and run C<perl Configure.pl> to create the makefile
for your platform.

=item 2
Expand Down Expand Up @@ -175,16 +169,8 @@ helpful to subscribe and keep up on changes that people are making.

L<http://lists.parrot.org/mailman/listinfo/parrot-commits>

=item * Parrot Commits NNTP Interface

L<...>

L<...>

=item * Commit List Archives, RSS

L<...>

L<http://lists.parrot.org/pipermail/parrot-commits/>

=back
Expand All @@ -198,8 +184,6 @@ with real-time discussion. Visit the channel #parrot on the IRC
server L<irc.parrot.org>. Alternative IRC servers are
L<irc.rhizomatic.net> and L<irc.pobox.com>.



=head2 I've developed a patch. What should I do with it?

See F<docs/submissions.pod> for details.
Expand Down
2 changes: 1 addition & 1 deletion docs/parrot.pod
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ See:

=item * L<https://trac.parrot.org/>

=item * L<https://svn.parrot.org/>
=item * L<http://github.com/parrot/parrot>

=back

Expand Down
5 changes: 0 additions & 5 deletions docs/pdds/pdd00_pdd.pod
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,6 @@ A short, general description of a specific part of the Parrot design. This may
be a particular subsystem (e.g. the garbage collector), or a more general
topic (e.g. basic Parrot datatypes).

=item Version:

Document version. Since Parrot is currently kept in a Subversion repository,
the $$-delimited keyword "Revision" will do nicely.

=item Abstract:

A quick blurb explaining the purpose of the PDD.
Expand Down
79 changes: 0 additions & 79 deletions docs/pdds/pdd07_codingstd.pod
Original file line number Diff line number Diff line change
Expand Up @@ -498,81 +498,6 @@ the variables happen to have the same names.
You could hoist the C<int i;> outside the test, but then you'd have an
C<i> that's visible after it's used, which is confusing at best.

=head3 Subversion Properties

=head4 svn:ignore

Sometimes new files will be created in the configuration and build process of
Parrot. These files should not show up when checking the distribution with

svn status

or

perl tools/dev/manicheck.pl

The list of these ignore files can be set up with:

svn propedit svn:ignore <PATH>

In order to keep the two different checks synchronized,
the MANIFEST and MANIFEST.SKIP files should be regenerated with:

perl tools/dev/mk_manifest_and_skip.pl

and the files then committed to the Parrot svn repository.

=head4 svn:mime-type

The C<svn:mime-type> property must be set to C<text/plain> for all test
files, and may be set to C<text/plain> for other source code files in
the repository. Using I<auto-props>, Subversion can automatically set
this property for you on test files. To enable this option, add the
following to your F<~/.subversion/config>:

[miscellany]
enable-auto-props = yes
[auto-props]
*.t = svn:mime-type=text/plain

The F<t/distro/file_metadata.t> test checks that the files needing
this property have it set.

=head4 svn:keywords

The C<svn:keywords> property should be set to:

Author Date Id Revision

on each file with a mime-type of C<text/plain>. Do this with the command:

svn propset svn:keywords "Author Date Id Revision" <filename>

The F<t/distro/file_metadata.t> test checks that the files needing
this property have it set.

=head4 svn:eol-style

The C<svn:eol-style> property makes sure that whenever a file is checked out
of subversion it has the correct end-of-line characters appropriate for
the given platform. Therefore, most files should have their
C<svn:eol-style> property set to C<native>. However, this is not true
for all files. Some input files to tests (such as the C<*.input> and
C<*.output> files for PIR tests) need to have C<LF> as their
C<svn:eol-style> property. The current list of such files is described in
F<t/distro/file_metadata.t>.

Set the C<svn:eol-style> property to C<native> with the command:

svn propset svn:eol-style "native" <filename>

Set the C<svn:eol-style> property to C<LF> with the command:

svn propset svn:eol-style "LF" <filename>

The F<t/distro/file_metadata.t> test checks that the files needing
this property have it set.

=head3 Naming Conventions

=over 4
Expand Down Expand Up @@ -821,10 +746,6 @@ The Pod documentation should follow the layout:

=over 4

=item Version

A SVN id string.

=item Title

=head1 Foo
Expand Down
7 changes: 0 additions & 7 deletions docs/project/cage_cleaners_guide.pod
Original file line number Diff line number Diff line change
Expand Up @@ -333,13 +333,6 @@ If neither, please report your findings so that everyone can decide what to do.

=head1 Handy configuration tips

=head2 Subversion configuration and automatic properties

There is an example C<.subversion/config> file in
F<editor/subversion_config> which is useful in automatically setting the
appropriate Subversion properties relevant to Parrot on addition of new
files.

=head2 Displaying trailing whitespace in vim and emacs

=head3 Vim
Expand Down
2 changes: 1 addition & 1 deletion docs/project/debian_packaging_guide.pod
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ directory should be named "parrot-<version>" (it will be by default).
Copy the debian/ directory from the Parrot source tree into the fresh tarball
extract.

cp -r <path/to/parrot/svn>/ports/debian ~/deb/parrot/parrot-<version>/.
cp -r <path/to/parrot/git>/ports/debian ~/deb/parrot/parrot-<version>/.

Copy the original tarball into ~/deb/parrot, naming it
"parrot_<version>.orig.tar.gz" (note the "_" in place of dash).
Expand Down
Loading

0 comments on commit 8beef6b

Please sign in to comment.