~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to lib/lp/registry/doc/distroseries.txt

  • Committer: William Grant
  • Date: 2010-03-12 06:19:52 UTC
  • mfrom: (10494 launchpad)
  • mto: (7675.583.7)
  • mto: This revision was merged to the branch mainline in revision 10501.
  • Revision ID: me@williamgrant.id.au-20100312061952-azff3x03cw3m73we
Merge devel.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
= DistroSeries =
 
1
DistroSeries
 
2
============
2
3
 
3
4
From the DerivationOverview spec
4
5
<https://launchpad.canonical.com/DerivationOverview>:
200
201
   True
201
202
 
202
203
 
203
 
== Package searching ==
 
204
Package searching
 
205
-----------------
204
206
 
205
207
You can search through binary packages publishing in a distribution
206
208
release by using the searchPackages method, which uses magical fti:
223
225
    DistroSeriesBinaryPackage: at
224
226
 
225
227
 
226
 
== DistroSeriess have components and sections ==
 
228
DistroSeriess have components and sections
 
229
------------------------------------------
227
230
 
228
231
A distroseries has some number of components and/or sections which
229
232
are valid for that distroseries. These selections are used by (among
286
289
    partner
287
290
 
288
291
 
289
 
== DistroSeries can be initialised from their parents ==
 
292
DistroSeries can be initialised from their parents
 
293
--------------------------------------------------
290
294
 
291
295
When a distroseries is derived from another distroseries (be it a
292
296
derivative distribution, or simply the next release in a sequence from
396
400
    netapplet
397
401
 
398
402
 
399
 
Hiding translations
400
 
-------------------
401
 
 
402
 
The hide_all_translations flag, if set, hides a distroseries'
403
 
translations in the user interface.  The check for visibility happens in
404
 
checkTranslationsViewable.
405
 
 
406
 
    >>> untranslatable_series = factory.makeDistroRelease()
407
 
    >>> untranslatable_series.hide_all_translations = False
408
 
 
409
 
When translations are visible, checkTranslationsViewable() completes
410
 
normally.
411
 
 
412
 
    >>> from canonical.launchpad.webapp.interfaces import (
413
 
    ...     TranslationUnavailable)
414
 
    >>> def get_visibility_notice(series):
415
 
    ...     """Print the notice about series' translations being hidden."""
416
 
    ...     try:
417
 
    ...         series.checkTranslationsViewable()
418
 
    ...     except TranslationUnavailable, e:
419
 
    ...         return str(e)
420
 
    ...     return None
421
 
 
422
 
    >>> print get_visibility_notice(untranslatable_series)
423
 
    None
424
 
 
425
 
But when translations are hidden, it raises TranslationUnavailable.
426
 
 
427
 
    >>> untranslatable_series.hide_all_translations = True
428
 
    >>> print get_visibility_notice(untranslatable_series)
429
 
    Translations for this release series...
430
 
 
431
 
Exactly what message is displayed depends on the series' status.
432
 
 
433
 
    >>> untranslatable_series.status = SeriesStatus.EXPERIMENTAL
434
 
    >>> print get_visibility_notice(untranslatable_series)
435
 
    Translations for this release series are not available yet.
436
 
 
437
 
    >>> untranslatable_series.status = SeriesStatus.DEVELOPMENT
438
 
    >>> print get_visibility_notice(untranslatable_series)
439
 
    Translations for this release series are not available yet.
440
 
 
441
 
    >>> untranslatable_series.status = SeriesStatus.FROZEN
442
 
    >>> print get_visibility_notice(untranslatable_series)
443
 
    Translations for this release series are not currently available.
444
 
    Please come back soon.
445
 
 
446
 
    >>> untranslatable_series.status = SeriesStatus.CURRENT
447
 
    >>> print get_visibility_notice(untranslatable_series)
448
 
    Translations for this release series are not currently available.
449
 
    Please come back soon.
450
 
 
451
 
    >>> untranslatable_series.status = SeriesStatus.SUPPORTED
452
 
    >>> print get_visibility_notice(untranslatable_series)
453
 
    Translations for this release series are not currently available.
454
 
    Please come back soon.
455
 
 
456
 
    >>> untranslatable_series.status = SeriesStatus.OBSOLETE
457
 
    >>> print get_visibility_notice(untranslatable_series)
458
 
    This release series is obsolete.  Its translations are no longer
459
 
    available.
460
 
 
461
 
    >>> untranslatable_series.status = SeriesStatus.FUTURE
462
 
    >>> print get_visibility_notice(untranslatable_series)
463
 
    Translations for this release series are not available yet.
464
 
 
465
 
 
466
 
== Translatable Packages and Packaging ==
 
403
Translatable Packages and Packaging
 
404
-----------------------------------
467
405
 
468
406
You can easily find out what packages are translatable in a
469
407
distribution release:
668
606
   True
669
607
 
670
608
 
671
 
== SourcePackagePublishingHistory ==
 
609
SourcePackagePublishingHistory
 
610
------------------------------
672
611
 
673
612
IDistroSeries.getSourcePackagePublishing returns all the ISPPH
674
613
records for a given status in a given pocket. It makes easy to
1042
981
    thinclient-local-devices
1043
982
 
1044
983
 
1045
 
= Drivers =
 
984
Drivers
 
985
=======
1046
986
 
1047
987
Distributions have drivers, who are people that have permission to approve
1048
988
bugs and features for specific releases. The rules are that:
1124
1064
    mark
1125
1065
 
1126
1066
 
1127
 
== Lastest Uploads ==
 
1067
Lastest Uploads
 
1068
---------------
1128
1069
 
1129
1070
IDistroSeries provides the 'getLatestUpload' method which returns a
1130
1071
list of the last 5 (five) IDistroSeriesSourcePackageRelease (IDRSPR)
1150
1091
    0
1151
1092
 
1152
1093
 
1153
 
== Getting build records for a distro series ==
 
1094
Getting build records for a distro series
 
1095
-----------------------------------------
1154
1096
 
1155
1097
IDistroSeries inherits the IHasBuildRecords interfaces and therefore provides
1156
1098
a getBuildRecords() method.