Difference between revisions of "How to use sqlCVS from web admin"

From LinuxMCE
Jump to: navigation, search
(updated for clarification of specific steps required when using sqlCVS and webadmin to submit DTs)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Tutorials]]
+
[[Category:Development]]
 +
{{versioninfo|810Status=??|810UpdatedDate=12sept2010|810UpdatedBy=--[[User:Langstonius|Langstonius]] 02:42, 14 September 2010 (CEST)}}
  
In order to propagate your local changes to the community, the local changes from database need to be committed in central repository using [[sqlCVS]].
+
In order to propagate your local changes to the community you must do the following:
 +
*join #linuxmce-devel on Freenode irc, and stay connected
 +
*create a ticket in svn, remember the ticket #.
 +
*update your local database with changes from the central repository, using [[sqlCVS]].
 +
*update the central repository with changes from your local database, using [[sqlCVS]], you must refer to the svn ticket # you created in the description you provide.
 +
*get the sqlCVS batch numbers from irc as you submit with sqlCVS
 +
*update the svn ticket you created with the sqlCVS batch number(s) you saw in irc.
 +
*ask a dev in #linuxmce-devel to check and approve your submission.
 +
*stay in #linuxmce-devel and monitor your ticket on svn for any questions/issues which may arise.
 +
*once complete a dev will close the ticket and the template will be available to all LinuxMCE users.
  
Go to '''Advanced > sqlCVS > Diff'''
+
Detailed:
  
Default values for connection are:
+
<ol>
 
+
<li>You must join #linuxmce-devel irc channel on Freenode and stay connected while you submit your template.  This will allow you do get the sqlCVS batch numbers for your device template submission for properly documenting, and requesting approval of, your device template.</li>
   sqlCVS Host:  sqlcvs.linuxmce.org
+
<li>Go to '''Advanced > sqlCVS > Update'''</li>
 +
:*Default values for connection are:
 +
   sqlCVS Host:  schema.linuxmce.org
 
   Port: 3999
 
   Port: 3999
 
   Username*: anonymous
 
   Username*: anonymous
   Password*: anonymous
+
   Password*: nopass
 
   Database: pluto_main
 
   Database: pluto_main
 +
:*Select all check boxes and click "Next".
 +
<li>Go to svn.linuxmce.org and create a new ticket indicating the name of the device template you are submitting.  Record and remember the ticket number (XXXXX) as you will need to return to it later.</li>
 +
<li>Go to '''Advanced > sqlCVS > Diff'''</li>
 +
:* Select the repositories and the tables you want to check for changes. If you don't know what tables were changed, you can select all of them, but be advised this will take a long time to complete.
 +
:* If you only added a device template for example, you can select only '''dce''' repository, which will also select all tables in that repository. If you know what tables were changed, you can narrow the selection in order to run faster.
 +
:* If you added a new manufacturer, or infrared codes, you must also include the '''ir''' repository. 
 +
:* After you have made your selection, click "Next".
 +
:* The page will call /usr/pluto/bin/sqlCVS with the parameters selected on page, which will run an integrity check first, then display the changes in the selected repository(s) and tables (new/changed/deleted records).
 +
:* Each record added/changed/deleted will have a checkbox next to it, so you will be able to select which changes you will checkin or revert.
 +
:* In the description you must refer to the svn ticket (XXXXX) you created above, you should create it similar to this:
 +
Refers to #XXXXX, device template for My New Device
 +
:* Once your selection is done, you can click "Checkin" at the very bottom of the page.  Be careful, "Revert" will remove the selected changes from your local system instead of submitting them.
 +
  Important note: BEFORE you click "Checkin", or "Revert", you MUST disable all popup blockers in your browser or this will not work.
 +
:* Depending of the button you clicked, the operations you selected will be reverted or committed to thesqlCVS main database (central repository).  This may take a while, depending on the amount of records/tables used.
 +
<li>Return to the ticket you created in svn and reply to it, put the sqlCVS batch number(s) you saw on the #linuxmce-devel irc channel in your reply.</li>
 +
<li>Request a dev approve your sqlCVS batches.</li>
 +
<li>Stay connected in #linuxmce-devel, and monitor your ticket in svn.  The devs have questions or there may be issues to resolve.</li>
 +
<li>Upon successful submission/approval of your device template the devs will close the ticket you created and the device will be available to all linuxmce users.  Thank you for contributing!</li>
 +
</ol>
 +
{{p}}
  
Select the repositories and the tables you want to check for changes. If you don't know what tables were changed, you can select all of them, but be advised this will take a long time to complete.
+
==Submitting Device Templates==
 
+
The process of submitting your device template is similar to the process described above. However, there are some special considerations to take into account.
If you only added a device template for example, you can select only '''dce''' repository, which will also select all tables in that repository. If you know what tables were changed, you can narrow the selection in order to run faster. After you made your selection, click "Next".
+
*Always submit your templates one at a time. Follow the procedure for each one individually. It can be cumbersome but it prevents problems down the road.
 
+
*Always submit your templates when doing a clean installation. Dont do it 6 months later, do it when installing. Taking the time to do it properly saves you and other LinuxMCE users time down the road.
The page will call /usr/pluto/bin/sqlCVS with the parameters selected on page, who will run an integrity check first, then will display what changes are in selected repository and tables (new/changed/deleted records).
+
 
+
Each record added/changed/deleted will have a checkbox next to it, so you will be able to select what changes to checkin or revert. Once your selection is done, you can click at the very bottom of the page either on "Revert" or "Checkin" buttons.
+
 
+
  Important note: BEFORE you click "Revert" or "Checkin" you have to disable popup blocker for the current host.
+
  
Depending of the button you clicked, the operations you selected will be reverted or committed in sqlCVS main database. Be advised this may take a while, depending on the amount of records/tables used.
+
With those considerations being said, the procedure is as follows.
 +
*Complete new LinuxMCE install to the point of being done with the initial setup wizard. This is neccesary because it would be difficult to login to web admin with no users.

Latest revision as of 22:21, 27 January 2013

Version Status Date Updated Updated By
710 Unknown N/A N/A
810  ?? 12sept2010 --Langstonius 02:42, 14 September 2010 (CEST)
1004 Unknown N/A N/A
1204 Unknown N/A N/A
1404 Unknown N/A N/A
Usage Information

In order to propagate your local changes to the community you must do the following:

  • join #linuxmce-devel on Freenode irc, and stay connected
  • create a ticket in svn, remember the ticket #.
  • update your local database with changes from the central repository, using sqlCVS.
  • update the central repository with changes from your local database, using sqlCVS, you must refer to the svn ticket # you created in the description you provide.
  • get the sqlCVS batch numbers from irc as you submit with sqlCVS
  • update the svn ticket you created with the sqlCVS batch number(s) you saw in irc.
  • ask a dev in #linuxmce-devel to check and approve your submission.
  • stay in #linuxmce-devel and monitor your ticket on svn for any questions/issues which may arise.
  • once complete a dev will close the ticket and the template will be available to all LinuxMCE users.

Detailed:

  1. You must join #linuxmce-devel irc channel on Freenode and stay connected while you submit your template. This will allow you do get the sqlCVS batch numbers for your device template submission for properly documenting, and requesting approval of, your device template.
  2. Go to Advanced > sqlCVS > Update
    • Default values for connection are:
     sqlCVS Host:  schema.linuxmce.org	
     Port: 	3999
     Username*: anonymous	
     Password*: nopass
     Database: pluto_main
    
    • Select all check boxes and click "Next".
  3. Go to svn.linuxmce.org and create a new ticket indicating the name of the device template you are submitting. Record and remember the ticket number (XXXXX) as you will need to return to it later.
  4. Go to Advanced > sqlCVS > Diff
    • Select the repositories and the tables you want to check for changes. If you don't know what tables were changed, you can select all of them, but be advised this will take a long time to complete.
    • If you only added a device template for example, you can select only dce repository, which will also select all tables in that repository. If you know what tables were changed, you can narrow the selection in order to run faster.
    • If you added a new manufacturer, or infrared codes, you must also include the ir repository.
    • After you have made your selection, click "Next".
    • The page will call /usr/pluto/bin/sqlCVS with the parameters selected on page, which will run an integrity check first, then display the changes in the selected repository(s) and tables (new/changed/deleted records).
    • Each record added/changed/deleted will have a checkbox next to it, so you will be able to select which changes you will checkin or revert.
    • In the description you must refer to the svn ticket (XXXXX) you created above, you should create it similar to this:
    Refers to #XXXXX, device template for My New Device
    
    • Once your selection is done, you can click "Checkin" at the very bottom of the page. Be careful, "Revert" will remove the selected changes from your local system instead of submitting them.
     Important note: BEFORE you click "Checkin", or "Revert", you MUST disable all popup blockers in your browser or this will not work.
    
    • Depending of the button you clicked, the operations you selected will be reverted or committed to thesqlCVS main database (central repository). This may take a while, depending on the amount of records/tables used.
  5. Return to the ticket you created in svn and reply to it, put the sqlCVS batch number(s) you saw on the #linuxmce-devel irc channel in your reply.
  6. Request a dev approve your sqlCVS batches.
  7. Stay connected in #linuxmce-devel, and monitor your ticket in svn. The devs have questions or there may be issues to resolve.
  8. Upon successful submission/approval of your device template the devs will close the ticket you created and the device will be available to all linuxmce users. Thank you for contributing!



Submitting Device Templates

The process of submitting your device template is similar to the process described above. However, there are some special considerations to take into account.

  • Always submit your templates one at a time. Follow the procedure for each one individually. It can be cumbersome but it prevents problems down the road.
  • Always submit your templates when doing a clean installation. Dont do it 6 months later, do it when installing. Taking the time to do it properly saves you and other LinuxMCE users time down the road.

With those considerations being said, the procedure is as follows.

  • Complete new LinuxMCE install to the point of being done with the initial setup wizard. This is neccesary because it would be difficult to login to web admin with no users.