aboutsummaryrefslogtreecommitdiffstats
path: root/Tools/scripts/README
blob: 9c276ea51298ddf4d9ce88f70185cc1b30aab7cc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
$FreeBSD$

addport - future replacement for easy-import

consistency-check -  check whether all your ports are installed properly,
                     what files have changed, and what new files there are
checknewvers - checks for availability for a newest version of distfiles on
               MASTER_SITES (ftp only).
close-pr  - a slightly hacked version of edit-pr(1) to quickly close PR.
distclean - compare md5 sums of distfiles in ports/distfiles with currently
            installed ports collection in ports/* and prompt to remove
            unmatched entries
getpr   - downloads a problem report from GNATS and attempts to extract
          the patch, shar, uuencoded file from it.
          this probably needs to be checked for potential security problems.
gnomedepends - Analyse pkg/PLIST and give an advice as to which GNOME ports
               should be listes in {RUN,LIB}_DEPENDS for this port 
prpatch - just does `patch $1 < pr-patch' (pr-patch is created by getpr)
prdone  - checks in the port, attempting to fill out the commit message using
          information from the problem report and then takes you into edit-pr
          so you don't forget to close the PR.

----------------------------------------------------------------------

consistency-check gives output like:

Not on filesystem - jade from jade-1.2.1
Only on filesystem - jadefoo
No package md5 available for lessecho
File nsgmls owned by multiple packages sp-1.3.4,jade-1.2.1
No filesystem md5 available for setuser, but it exists                          
For sgmlnorm, package md5 312d7b63d591e07629e0da4ae4a0ac07 is DIFFERENT from fs md5 of 19f1f901911b90d8e04c6ea69e1b0541!

change $do_md5 to 0 to not check md5, and $do_fs to 0 to not check for
files above those installed by packages.

----------------------------------------------------------------------

getpr, prpatch and prdone are used as so:
    % cd /usr/ports/CATEGORY/PORT
    % getpr PRNUMBER
    <read diff presented to you>
    <check that there are no followups to the PR as getpr wont' split
     them out of the PR>
    % prpatch
    <test port>
    % prdone PRNUMBER ci
    <this will attempt to fill out the cvs log message, check in the
     port and edit-pr the problem report so you can close it>

----------------------------------------------------------------------

checksum is a script that allows checking of ports to see if their checksums
match, and if they don't, give a diff against the older version to try and
discover why the checksum didn't match.

----------------------------------------------------------------------

distclean is a script that allows to compare md5 checksums of distfiles in
ports/distfiles with list of all md5 sums listed in "md5" files in the ports
collection. After comparing, utility will prompt to remove distfiles which
doesn't have associated md5 entry (most likely outdated distfiles).

----------------------------------------------------------------------

gnomedepends is a script, which analyses pkg/PLIST and gives an advice as to
which GNOME ports should be listes in {RUN,LIB}_DEPENDS for the port to ensure
correct removal of GNOME shared directories. Usage is simple:
    % cd /usr/ports/CATEGORY/PORT
    % gnomedepends.py
    According to the contents of PLIST the port depends on the following GNOME
    port(s):

    /usr/ports/audio/gnomeaudio, for directories:
            share/gnome/sounds

    /usr/ports/sysutils/gnomecontrolcenter, for directories:
            share/gnome/apps

    /usr/ports/x11/gnomecore, for directories:
            share/gnome/apps/Games

    /usr/ports/x11/gnomelibs, for directories:
            etc/sound/events
            etc/sound
            share/gnome/games
            share/gnome/pixmaps
            share/gnome

The example above means that you need to have ${PORTSDIR}/audio/gnomeaudio,
${PORTSDIR}/sysutils/gnomecontrolcenter, ${PORTSDIR}/x11/gnomecore and
${PORTSDIR}/x11/gnomelibs listed in {RUN,LIB}_DEPENDS for this port.
Please be warned, that the this only means that the ports listed by the script
required for correct removal of GNOME shared directories, not for the port
functionality, so actual {RUN,LIB}_DEPENDS may have more entries.

----------------------------------------------------------------------

NOTE: These scripts need work and are *NOT* safe to use unless you know
      what they do.  Use at your own risk.  Patches would be great, but
      it is prefered they pass through maintainer of each particular script.