← Back to team overview

launchpad-reviewers team mailing list archive

[Merge] lp:~maxiberta/launchpad/snap-pocket-help into lp:launchpad

 

Maximiliano Bertacchini has proposed merging lp:~maxiberta/launchpad/snap-pocket-help into lp:launchpad.

Commit message:
Make pocket selection for snap builds less unclear.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~maxiberta/launchpad/snap-pocket-help/+merge/300626

Make pocket selection for snap builds less unclear.

* Reworded pocket field description in +new-snap and Snap:+edit.
* Added pocket field description in Snap:+request-builds.
* Added help link with a brief description of available pockets (mentioning the recommended default).
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~maxiberta/launchpad/snap-pocket-help into lp:launchpad.
=== modified file 'lib/lp/snappy/browser/snap.py'
--- lib/lp/snappy/browser/snap.py	2016-07-16 07:46:23 +0000
+++ lib/lp/snappy/browser/snap.py	2016-07-20 15:26:47 +0000
@@ -242,11 +242,17 @@
             Choice(vocabulary='SnapDistroArchSeries'),
             title=u'Architectures', required=True)
         pocket = Choice(
-            title=u'Pocket', vocabulary=PackagePublishingPocket, required=True)
+            title=u'Pocket', vocabulary=PackagePublishingPocket, required=True,
+            description=u'The set of packages with which this snap package '
+                'should be built.')
 
     custom_widget('archive', SnapArchiveWidget)
     custom_widget('distro_arch_series', LabeledMultiCheckBoxWidget)
 
+    help_links = {
+        "pocket": u"/+help-snappy/snap-build-pocket.html",
+    }
+
     @property
     def cancel_url(self):
         return canonical_url(self.context)
@@ -377,6 +383,10 @@
     custom_widget('auto_build_archive', SnapArchiveWidget)
     custom_widget('store_channels', LabeledMultiCheckBoxWidget)
 
+    help_links = {
+        "auto_build_pocket": u"/+help-snappy/snap-build-pocket.html",
+    }
+
     def initialize(self):
         """See `LaunchpadView`."""
         super(SnapAddView, self).initialize()
@@ -664,6 +674,10 @@
     custom_widget('git_ref', GitRefWidget)
     custom_widget('auto_build_archive', SnapArchiveWidget)
 
+    help_links = {
+        "auto_build_pocket": u"/+help-snappy/snap-build-pocket.html",
+    }
+
     def setUpFields(self):
         """See `LaunchpadFormView`."""
         super(SnapEditView, self).setUpFields()

=== added file 'lib/lp/snappy/help/snap-build-pocket.html'
--- lib/lp/snappy/help/snap-build-pocket.html	1970-01-01 00:00:00 +0000
+++ lib/lp/snappy/help/snap-build-pocket.html	2016-07-20 15:26:47 +0000
@@ -0,0 +1,33 @@
+<html>
+  <head>
+    <title>Pocket for snap builds</title>
+    <link rel="stylesheet" type="text/css"
+          href="/+icing/yui/cssreset/reset.css" />
+    <link rel="stylesheet" type="text/css"
+          href="/+icing/yui/cssfonts/fonts.css" />
+    <link rel="stylesheet" type="text/css"
+          href="/+icing/yui/cssbase/base.css" />
+    <style type="text/css">
+      p { margin-bottom: 0.5em }
+    </style>
+  </head>
+  <body>
+    <h1>Pocket for snap builds</h1>
+
+    <p>Package repositories may contain many versions of a package, each in a different subdirectory or <em>pocket</em>.</p>
+    <p>If unsure, choose <strong>Updates</strong>.</p>
+    <dl>
+        <dt><strong>Release</strong></dt>
+        <dd>The current stable Ubuntu release. Package versions are frozen and do not change.</dd>
+        <dt><strong>Security</strong></dt>
+        <dd>Patches for security vulnerabilities in Ubuntu packages. They are managed by the Ubuntu Security Team and are designed to change the behavior of the package as little as possible -- in fact, the minimum required to resolve the security problem. As a result, they tend to be very low-risk to apply and all users are urged to apply security updates. Packages in <em>Security</em> are built with dependencies from <em>Release</em> and <em>Security</em>.</dd>
+        <dt><strong>Updates</strong></dt>
+        <dd>Updates for serious bugs in Ubuntu packaging that do not affect the security of the system. Packages in <em>Updates</em> are copied from <em>Proposed</em> once they have been tested.</dd>
+        <dt><strong>Proposed</strong></dt>
+        <dd>The testing area for updates. This repository is recommended only to those interested in helping to test updates and provide feedback. Packages in <em>Proposed</em> are built with dependencies from <em>Release</em>, <em>Security</em>, <em>Updates</em> and <em>Proposed</em>.</dd>
+        <dt><strong>Backports</strong></dt>
+        <dd>As the name states, these are unsupported new versions of packages which have been backported to an older release. Packages may contain new features, may introduce new interfaces, and bugs. Packages in <em>Backports</em> are built with dependencies from <em>Release</em>, <em>Security</em> and <em>Backports</em>.</dd>
+    </dl>
+  </body>
+</html>
+

=== modified file 'lib/lp/snappy/interfaces/snap.py'
--- lib/lp/snappy/interfaces/snap.py	2016-07-15 17:11:09 +0000
+++ lib/lp/snappy/interfaces/snap.py	2016-07-20 15:26:47 +0000
@@ -381,8 +381,8 @@
         title=_("Pocket for automatic builds"),
         vocabulary=PackagePublishingPocket, required=False, readonly=False,
         description=_(
-            "The pocket for which automatic builds of this snap package "
-            "should be built.")))
+            "The set of packages with which automatic builds of this snap "
+            "package should be built.")))
 
     is_stale = Bool(
         title=_("Snap package is stale and is due to be rebuilt."),


Follow ups