Difference between revisions of "Make Minor Modifications to a PBI Module"

From PC-BSD Wiki
Jump to: navigation, search
(Created page with "<noinclude><translate> <!--T:1--> {{UseTOC{{putVers}}|Nav}}</noinclude> <!--T:2--> The previous section indicated that new PBI modules are uploaded to the PBI build server s...")
 
m (Drulavigne moved page Test or Modify PBI Modules/10.1 to Make Minor Modifications to a PBI Module without leaving a redirect)
 
(8 intermediate revisions by one user not shown)
Line 4: Line 4:
 
{{UseTOC{{putVers}}|Nav}}</noinclude>
 
{{UseTOC{{putVers}}|Nav}}</noinclude>
  
<!--T:2-->
+
<!--T:17-->
The previous section indicated that new PBI modules are uploaded to the PBI build server so that they can be built and tested. This section describes the two ways you can assist in testing PBIs.[[File:Build1d.png|thumb|393px|'''Figure 11.5a: Viewing the Status of PBIs on the Build Server''']]
+
If you have a GitHub account and are logged in, you can contribute minor PBI changes to the {{citelink|url=https://github.com/pcbsd/pcbsd/tree/master/pbi-modules|txt=pbi-modules in the PC-BSD® repository}} using a web browser. If you do not have a GitHub account, create one [https://github.com/ here] and use a valid email address as you will need to confirm your email address.
  
=== Test PBIs Waiting for Approval === <!--T:6-->
+
<!--T:18-->
 +
For example, to add a screenshot for an application, upload the screenshot file to a publicly accessible site, then add the URL to the screenshot in between the quotes of the ''PBI_SCREENSHOTS=""'' line in the ''pbi.conf'' file for that module. Or, to add a similar application, put the package category and package name in between the ''PBI_PLUGINS=""'' line in the ''pbi.conf'' file for that module. As an example, refer to the [https://github.com/pcbsd/pcbsd/blob/master/pbi-modules/www/firefox/pbi.conf pbi.conf for the www/firefox PBI module]. More information about the the available ''pbi.conf'' variables can be found in [[EasyPBI2/10.1#pbi.conf|Table 8.1b]].
  
<!--T:7-->
+
<!--T:19-->
If you wish to help test a PBI before it has been approved, go to the {{citelink|url=http://pbibuild64.pcbsd.org/index.php?ver=10|txt=build server}} as shown in Figure 11.5a.
+
To make the edit, click on the ''pbi.conf'' file for the module, click the "Edit" button, make the change, then click the "Commit changes" button. This will issue a "git pull" request which will be reviewed by a developer who will either approve it or contact you if more information about the edit is needed. Once the request is approved, you will receive an email about the approval and the change will appear in [[AppCafe®/10.1|AppCafe®]] when the next package set becomes available. How long that takes depends upon whether the system is set to use the PRODUCTION or EDGE package set.
 
+
<!--T:15-->
+
Find the name of the PBI you wish to test in the "Module" column and click its hyperlink. You can then download the file with the ''.pbi'' extension. Once downloaded, run '''pbi_add /path/to/pbi'''  to install the PBI. If you find any problems with the PBI, send an email to the {{citelink|pcbsdlists|url=pbi-dev|txt=PBI-dev}} mailing list describing how to recreate the problem. Include the text of any error messages you receive.
+
 
+
=== Investigate or Fix a Failed Build === <!--T:8-->
+
 
+
<!--T:9-->
+
You can try to resolve PBI modules that have a "Build Status" of "FAILED". If you click on the name of a failed module, you can download the file named ''last_100.log'' for that module. This file is in ASCII text so it can be viewed in any text editor.
+
 
+
<!--T:11-->
+
If you think you know the cause of the problem after reading the error messages, you can review the PBI's module by clicking its "git" hyperlink. If you decide to copy/paste a file in order to edit it locally, click the "Raw" link for the file.
+
+
If you make an edit to correct the problem, send the modified file (or a diff) to the {{citelink|pcbsdlists|url=pbi-dev|txt=PBI-dev}} mailing list so the changes can be uploaded to the build server.
+
  
 
<!--T:12-->
 
<!--T:12-->

Latest revision as of 12:31, 14 October 2014


Contents

[edit] Description

NOTE: Translators should localize the following templates used:

This damn spiffy template enables a centralized Handbook Table of Contents which can be used in multiple ways. It calls an entirely automagical NavHeader template which uses the chronological relationship in the page names within the UseTOC template to choose the back and forward links. The same ordered list provides the Table Of Contents page links and provides for the flat_html page (although wiki page limits prevent this). It necessarily works within the versioned page system, which means that this template will need to be duplicated for each of the future versions.

[edit] Usage

[edit] Navigation

{{UseTOC{{putVers}}|Nav}} invokes the NavHeader output similar to below:

But if the pages relating to the backward (left) or forward (right) icon/links are not yet defined by their translation, or if the page is not yet or no longer in the Table Of Contents then the result is as below:

Template loop detected: Template:UseTOC

[edit] Table Of Contents

{{UseTOC{{putVers}}|Toc}} invokes a formatted list of page links similar to below:
Preface
1. Introduction

1.1 Goals and Features
1.2 What's New in
1.3 PC-BSD® Releases
1.4 PC-BSD® for Linux Users

[edit] Flat HTML

{{UseTOC{{putVers}}|flat}} causes the flat_html page output (but is limited by page size which makes it incomplete/broken in actual use).

[edit] Modification

How to insert new pages into the Table Of Contents

If you have a GitHub account and are logged in, you can contribute minor PBI changes to the pbi-modules in the PC-BSD® repository[1] using a web browser. If you do not have a GitHub account, create one here and use a valid email address as you will need to confirm your email address.

For example, to add a screenshot for an application, upload the screenshot file to a publicly accessible site, then add the URL to the screenshot in between the quotes of the PBI_SCREENSHOTS="" line in the pbi.conf file for that module. Or, to add a similar application, put the package category and package name in between the PBI_PLUGINS="" line in the pbi.conf file for that module. As an example, refer to the pbi.conf for the www/firefox PBI module. More information about the the available pbi.conf variables can be found in Table 8.1b.

To make the edit, click on the pbi.conf file for the module, click the "Edit" button, make the change, then click the "Commit changes" button. This will issue a "git pull" request which will be reviewed by a developer who will either approve it or contact you if more information about the edit is needed. Once the request is approved, you will receive an email about the approval and the change will appear in AppCafe® when the next package set becomes available. How long that takes depends upon whether the system is set to use the PRODUCTION or EDGE package set.


References


  1. https://github.com/pcbsd/pcbsd/tree/master/pbi-modules
Other languages:German 0% • ‎English 100%