summaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorGuillem Jover <guillem@debian.org>2014-10-11 22:13:12 +0200
committerGuillem Jover <guillem@debian.org>2014-10-12 06:34:37 +0200
commit9b08b531fd0dcaa0da2558929172ce21c2d312b9 (patch)
tree123d6977500928b2db2d8deff1701cde87e6d135 /scripts
parent916aa6d3bbfa0d0290f5ba74706f71a68f6da0cd (diff)
downloaddpkg-9b08b531fd0dcaa0da2558929172ce21c2d312b9.tar.gz
scripts: Document private modules as such in a CHANGES section
This is to try to make sure, that even if documented, people will not accidentally rely on private modules, that have not API stability guarantees.
Diffstat (limited to 'scripts')
-rw-r--r--scripts/Dpkg/BuildEnv.pm6
-rw-r--r--scripts/Dpkg/Control/Types.pm6
-rw-r--r--scripts/Dpkg/Vendor/Debian.pm8
-rw-r--r--scripts/Dpkg/Vendor/Default.pm6
-rw-r--r--scripts/Dpkg/Vendor/Ubuntu.pm6
5 files changed, 32 insertions, 0 deletions
diff --git a/scripts/Dpkg/BuildEnv.pm b/scripts/Dpkg/BuildEnv.pm
index 2615d5d8e..6d41419f1 100644
--- a/scripts/Dpkg/BuildEnv.pm
+++ b/scripts/Dpkg/BuildEnv.pm
@@ -102,6 +102,12 @@ sub list_modified {
=back
+=head1 CHANGES
+
+=head2 Version 0.xx
+
+This is a private module.
+
=cut
1;
diff --git a/scripts/Dpkg/Control/Types.pm b/scripts/Dpkg/Control/Types.pm
index d8bc0b387..bdcdd239a 100644
--- a/scripts/Dpkg/Control/Types.pm
+++ b/scripts/Dpkg/Control/Types.pm
@@ -53,6 +53,12 @@ use constant {
CTRL_CHANGELOG => 512, # Output of dpkg-parsechangelog
};
+=head1 CHANGES
+
+=head2 Version 0.xx
+
+This is a private module.
+
=head1 AUTHOR
Raphaƫl Hertzog <hertzog@debian.org>.
diff --git a/scripts/Dpkg/Vendor/Debian.pm b/scripts/Dpkg/Vendor/Debian.pm
index f998c94a5..34bf28134 100644
--- a/scripts/Dpkg/Vendor/Debian.pm
+++ b/scripts/Dpkg/Vendor/Debian.pm
@@ -293,4 +293,12 @@ sub _add_hardening_flags {
}
}
+=head1 CHANGES
+
+=head2 Version 0.xx
+
+This is a private module.
+
+=cut
+
1;
diff --git a/scripts/Dpkg/Vendor/Default.pm b/scripts/Dpkg/Vendor/Default.pm
index f2d8affc1..9cb082ab4 100644
--- a/scripts/Dpkg/Vendor/Default.pm
+++ b/scripts/Dpkg/Vendor/Default.pm
@@ -131,6 +131,12 @@ sub run_hook {
=back
+=head1 CHANGES
+
+=head2 Version 0.xx
+
+This is a private module.
+
=cut
1;
diff --git a/scripts/Dpkg/Vendor/Ubuntu.pm b/scripts/Dpkg/Vendor/Ubuntu.pm
index c305e43e2..e83147e77 100644
--- a/scripts/Dpkg/Vendor/Ubuntu.pm
+++ b/scripts/Dpkg/Vendor/Ubuntu.pm
@@ -181,6 +181,12 @@ sub find_launchpad_closes {
=back
+=head1 CHANGES
+
+=head2 Version 0.xx
+
+This is a semi-private module. Only documented functions are public.
+
=cut
1;