P4Admin User Guide - Perforce · P4Admin User Guide 2018.2 April 2018 ... and groups using P4Admin,...
Transcript of P4Admin User Guide - Perforce · P4Admin User Guide 2018.2 April 2018 ... and groups using P4Admin,...
-
P4Admin User Guide2018.2
April 2018
-
Copyright1999-2018PerforceSoftware.
Allrightsreserved.
PerforceSoftwareanddocumentationisavailablefromwww.perforce.com.YoucandownloadandusePerforceprograms,butyoucannotsellorredistributethem.Youcandownload,print,copy,edit,andredistributethedocumentation,butyoucannotsellit,orsellanydocumentationderivedfromit.Youcannotmodifyorattempttoreverseengineertheprograms.
ThisproductissubjecttoU.S.exportcontrollawsandregulationsincluding,butnotlimitedto,theU.S.ExportAdministrationRegulations,theInternationalTrafficinArmsRegulationrequirements,andallapplicableend-use,end-useranddestinationrestrictions.Licenseeshallnotpermit,directlyorindirectly,useofanyPerforcetechnologyinorbyanyU.S.embargoedcountryorotherwiseinviolationofanyU.S.exportcontrollawsandregulations.
PerforceprogramsanddocumentsareavailablefromourWebsiteasis.Nowarrantyorsupportisprovided.Warrantiesandsupport,alongwithhighercapacityservers,aresoldbyPerforceSoftware.
PerforceSoftwareassumesnoresponsibilityorliabilityforanyerrorsorinaccuraciesthatmightappearinthisbook.Bydownloadingandusingourprogramsanddocumentsyouagreetotheseterms.
PerforceandInter-FileBranchingaretrademarksofPerforceSoftware.
Allotherbrandsorproductnamesaretrademarksorregisteredtrademarksoftheirrespectivecompaniesororganizations.
AnyadditionalsoftwareincludedwithinPerforceSoftwareislistedin"Licensestatements"onpage32.
https://www.perforce.com/
-
Contents
How to use this guide 4Feedback 4
Otherdocumentation 4
Syntaxconventions 4
Administering Helix Server using P4Admin 5Homepage 5
Serverconnections 6
Managingdepots 6
Managingusersandgroups 6
Managingpermissions 8
Viewpermissions 8Edittheprotectionstable 8
ConfiguringP4Adminpreferences 9
Connections 10ServerData 10Logging 10Display 11Files 11ApplicationFont 11Behavior 11Tools 12Editor 12Diff 13Applets 13
Glossary 14License statements 32
3
-
How to use this guideThisguidetellsyouhowtouseP4Admin,aGUIforadministratingHelixServerconnections.ItisintendedforanyoneusingP4AdmintoperformbasicHelixServeradministrativetasks.AccesstothecompletesetofadministrativetoolsrequiresP4,thecommand-lineclient.
Other documentationSeehttps://www.perforce.com/support/self-service-resources/documentation.
Syntax conventionsHelixdocumentationusesthefollowingsyntaxconventionstodescribecommandlinesyntax.
Notation Meaningliteral Mustbeusedinthecommandexactlyasshown.
italics Aparameterforwhichyoumustsupplyspecificinformation.Forexample,foraserveridparameter,supplytheIDoftheserver.
[-f] Theenclosedelementsareoptional.Omitthebracketswhenyoucomposethecommand.
... n Repeatsasmuchasneeded:l alias-name[[$(arg1)...
[$(argn)]]=transformation
n Recursiveforalldirectorylevels:
l clone perforce:1666 //depot/main/p4... ~/local-repos/main
l p4 repos -e //gra.../rep...
element1|element2
Eitherelement1orelement2isrequired.
4
mailto:[email protected]://www.perforce.com/support/self-service-resources/documentation
-
Administering Helix Server using P4AdminP4AdminprovidesagraphicaluserinterfaceforperformingbasicHelixServeradministrationtasks.Thischapterdiscussesthefollowingtopics:
Home page 5Server connections 6Managing depots 6Managing users and groups 6Managing permissions 8Viewpermissions 8Edittheprotectionstable 8
Configuring P4Admin preferences 9Connections 10ServerData 10Logging 10Display 11Files 11ApplicationFont 11Behavior 11Tools 12Editor 12Diff 13Applets 13
ToaccessP4AdminfromwithinP4V,gotoTools > Admininstration.
Home pageTheAdministrationhomepageenablesuserswithsuperandadminpermissionstoviewandusethefollowing:
n Server information:displaysdetailsabouttheservertowhichyouareconnected.
n Disk space usage:displaysdetailsaboutserverdiskspaceusage.
n Security level:displaysauthenticationlevelrequiredbyuserswhoaccesstheserver.
n Account management shortcuts:displayslinkstocommontasks.
n User licenses:displaysdetailsaboutlicensecountandexpiration.
n Inactive users:displaysdetailsaboutuserswhohavenotaccessedtheiraccountintheperiodoftimeyouspecify.
5
-
Server connections
Server connectionsToadministeraserver,youmustfirstconnecttoitasauserthathasbeengrantedsuperuserprivilegefortheserver.(Ifyouruserdoesnothavesuperuserprivilege,youcanstilladministerusersandgroups,butcannotmanagepermissionsordefinedepots.)
Toconnecttoaserver,chooseConnections > Open Connection.SpecifythedesiredsettingsandclickOK.Toadministeraserver,activatetheconnectionbyclickingitsentryintheConnectionspane.Toremoveaconnection,right-clickitandselectClose Connection.
P4Adminretainsallconnectionsthatyoudefine,soyoudonotneedtoreenterthemthenexttimeyoulaunchthetool.
Managing depotsIfyouhavesuperuserpermissionfortheHelixServerinstancetowhichyouareconnected,youcanmanagethedepotsthatitcontains.Specifically,youcan:
n Displaydetailsaboutadepot
n Create,edit,ordeletedepots
n Obliteratefilesfromadepot
Warning Obliteratewithextremecaution.ObliterationpermanentlyremovesalltracesofthespecifiedfilesfromtheHelixServer,includingrevisionrecordsandmetadata(suchasreferencesinlabelsandclientworkspacespecifications).Filesinclientworkspacesareleftuntouched,butarenolongerrecognizedasbeingunderHelixServercontrol.
Managing users and groupsAlluserscandisplaylistsofusersandgroupsusingP4Admin,butonlyuserswithadminorsuperpermissionscanmakechanges.Fordetailsaboutaccesslevels,refertotheHelix Versioning Engine Administrator Guide: Fundamentals.
To view the users defined for the server to which you are connected,selectTools > AdministrationandclicktheUsers & Groupstab.
To display details about a user,clickthedesireduserspecification.ThedetailsaboutthatuseraredisplayedatthebottomoftheUserstab.
To create a user:
1. InP4V,selectTools > Administration.P4Adminopens.
2. ChooseFile > New > User.
6
http://www.perforce.com/perforce/doc.current/manuals/p4sag/index.htmlhttp://www.perforce.com/perforce/doc.current/manuals/p4sag/index.html
-
Managing users and groups
TheUserdialogopens.
3. Enteruserinformationasfollows.ClickOKaftermakingyourentries.
User TheHelixServerusername.
Password Thepassword(ifany)requiredfortheusertoconnecttotheserver.
Email Theusersemailaddress.
Full name
Theusersrealname.
Job view (Optional)Criteriaspecifyingwhichjobsareautomaticallyincludedonanynewchangelistscreatedbytheuser
Example:User=bruno Status=open
Fordetails,refertothedescriptionofthep4 jobs-eflaginthePerforce Command Reference.
Reviews Filesofinteresttotheuser,specifiedusingdepotsyntax
Whenchangeliststhataffectthefilearesubmitted,theuserreceivesemailnotificationofthechange.NotethatyoucanalsospecifyfilesofinterestbyclickingtheReviewstab.
Groups Groupstowhichtheuserbelongs
Toaddtheusertoagroup,enterthenameofthegroupintheGroupfieldandclickAdd,orclickBrowse,selectthegroup,andclickOK.
To change your password:SelectAdministration > Change Password.
To display the groups to which a user belongs,expandtheuserintheUserspane.To display the users in a group,expandthegroupintheGroupspane.
To edit a user or group,right-clicktheuserorgroupyouwanttoeditandselectEdit.
To see the areas of the depot tree to which a user has access,right-clicktheuser,andselectShow Permissions.ThePermissionstabisdisplayed,withtheselecteduserhighlighted.
To add a user to a group,dragtheuserfromtheUserspanetothedesiredgroup.To remove a user from a group,right-clicktheuserinthegroupandchooseRemove.
To edit the groups to which a user belongs:
1. Right-clicktheuserandselectEdit User.
TheUserdialogisdisplayed.
2. EditthelistdisplayedintheGroup membershipfield.
7
http://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_jobs.htmlhttp://www.perforce.com/perforce/doc.current/manuals/cmdref/p4_jobs.html
-
Managing permissions
Managing permissionsFordetailsabouthowpermissionsworkwithinHelixServer,seetheHelix Versioning Engine Administrator Guide: Fundamentals.
View permissionsTo display the files and folders to which a user has access,clickthedesireduserontheUserstab.
To display the files and folders to which users in a group have access,clickthedesiredgroupontheGroupstab.
To display the groups and users that have access to a file or folder,clickthefileorfolderontheDepot Treetab.
To see which lines of the protections table control accesstoauser,group,orareaofthedepot,clicktheuser,grouporfolderofinterest.Thecorrespondinglineintheprotectionstableishighlighted.(Ifauserorgroupisneithergrantednordeniedaccesstoapathbymeansofanyentriesintheprotectionstable,thedepotpathdisplays"noaccess"andthe"grantedto"fieldisblank.)
To filter out lines in the right-hand pane,usetheAccess Levelsliderstosetthelowestandhighestlevels.Theareasofthedepotassociatedwiththehighlightedrangeofaccessvaluesaredisplayed.
To see only those permissions that apply to a users workstation,entertheIPaddressoftheworkstationintheHost IP filterfield.Forexample,permissionslineswithahostvalueof92.168.*.*and192.168.1.*bothapplytoaworkstationat192.168.1.10.
To show files in the Depot Tree,clickShow files.
Note VirtualstreamsdonotappearintheDepotTreeonthePermissionstab.Virtualstreamsmaptheirparentspaths,andpermissionsforvirtualstreamsarethereforealwayssetfortheparentspaths.
Edit the protections tableTheprotectionstableisdisplayedinthebottompaneofthescreen.Itisarepresentationofthetableusedbythep4 protectcommand,withexclusionarylinesshowninred.Formoreinformationonthep4 protectcommand,seep4 protectintheP4 Command Reference.
Toedittheprotectionstable,usethebuilt-ineditororclick toedittheprotectionstableastext.
Todenyaccesstoaspecificportionofthedepottoauserorgroup,useanexclusionarymapping:placeadash(-)infrontofthepathintheFolder/Filefield.Exclusionarymappingsapplytoallaccesslevels,eventhoughonlyoneaccesslevelcanbeselectedintheAccess Levelfield.
Thefollowingtabledescribesthefieldsintheprotectionstable.
8
http://www.perforce.com/perforce/doc.current/manuals/p4sag/index.htmlhttp://www.perforce.com/perforce/doc.current/manuals/p4sag/index.htmlhttps://www.perforce.com/perforce/doc.current/manuals/cmdref/#CmdRef/p4_protect.html#p4_protecthttp://www.perforce.com/perforce/doc.current/manuals/cmdref/index.html
-
Configuring P4Admin preferences
Access Level
Thepermissionbeinggranted.Eachpermissionlevelincludesalllower-levelpermissions,exceptforreview.
n super:Grantsaccessallcommandsandcommandoptions
n admin:Permitsthoseadministrativecommandsandcommandoptionsthatdontaffectserversecurity
n write:Letsuserssubmitopenfiles
n open:Letsusersopenfilesforadd,edit,delete,andintegrate
n read:Letsuserssync,diff,andprintfiles
n list:Letsusersseenamesbutnotcontentsoffiles;userscanseeallnon-filerelatedmetadata(workspaces,users,changelists,jobs,etc.
n review:Allowsaccesstothep4 reviewcommand.Thisleveisintendedforautomatedprocesses.Itimpliesreadaccess.
n ##:Addsacommentlinetotheprotectionstable.Forexample:
## robinson crusoe
write user * 10.1.1.1 //depot/test/...
User/Group IndicateswhetherthislineappliestoaPerforceuserorgroup.
Name AHelixServerusernameorgroupname;canbewildcarded.
Host TheIPaddressofaclienthost;canbewildcarded.
Folder/File Thepartofthedepottowhichaccessisbeinggrantedordenied.Todenyaccesstoadepotpath,prefacethepathwithadash(-).Exclusionarymappingsapplytoallaccesslevels,regardlessoftheaccesslevelspecifiedinthefirstfield.
Comment Optionaldescriptionofatableentry.Appendsacommentattheendofalineusingthe##symbols.Forexample:write user * 10.1.1.1 //depot/test/... ## robinson crusoe
Configuring P4Admin preferencesToconfiguresettingsforP4Admin,selectEdit > Preferences(Windows)orP4Admin > Preferences(Mac).ThePreferencesdialogincludesthefollowingconfigurationpages:
n "Connections"onthenextpage
n "Logging"onthenextpage
n "Display"onpage11
n "Files"onpage11
n "Behavior"onpage11
n "Tools"onpage12
9
-
Connections
n "Editor"onpage12
n "Diff"onpage13
ClickApplytosaveyourchanges.ClickOKtosaveyourchangesandexitthedialog.
ConnectionsYoucanconfigurethefollowingsettingsforconnectingtoaHelixServer:
When the application launches:
n Restore all previously opened connections:Donotpromptforconnectionsettings;reconnecttotheservertowhichyouwereconnectedduringyourlastsession.
Opening and closing connections:
n Use IP-specific tickets when logging in:SpecifieswhetheryourloginticketisrestrictedtotheIPaddressfromwhichyouareconnecting.
n Automatically log off when closing a connection:Specifieswhetheryourticketisinvalidatedwhenyoulogout.
Server DataYoucanconfigurehowmuchdataP4Adminprocessesduringasessiontominimizeserverloadforfrequentlyruncommandsandlargedatatransfers.Thefollowingsettingsareavailable:
n Check server for updates every n minutes:SpecifieshowoftenP4AdminchecksthePerforceserviceforupdatedfileinformation.FrequentchecksenableP4AdmintodisplaycurrentfilestatusbutincreasetheworkloadonthePerforceservice.
n Maximum size of file to preview (excludes audio and video files):LimitsthesizeofimagefilesdisplayedinthePreviewtabontheFilespane,tolimittheamountofimagedatasentfromthePerforceservicetoP4V.
LoggingYoucanconfigurethefollowingloggingoptions:
Log pane options:
n Show p4 reporting commands:SpecifieswhetherthelogpaneintheAdministrationToolwindowdisplaysallcommandsissuedbytheAdministrationTool,includingcommandsissuedbytheAdministrationTooltoobtainstatusinformationfromtheHelixServer.
Logging to a file:
10
-
Display
n Enable logging to file:LogsAdministrationToolactivitytothespecifiedfile.
l Name:Specifiesthenameandlocationofthelogfile.
l Size:Specifiesthemaximumsizeofthelogfile.
DisplayYoucanconfigurethefollowingAdministrationTooldisplayandlocalizationoptions:
Application:
n Dates:SetsthedateformatusedthroughouttheAdministrationTool.
l OS format:Usetheformatthatyouroperatingsystemuses.
l Perforce standard (yyyy/mm/dd hh:mm:ss):Usetheapplicationstandard.
Localization:
n Language used for application menus, labels, and dialogs (requires restart):Selectlanguage.
n Set encoding for all connections to:Setsthecharacterencodingforconnectionstoaunicode-modeHelixServer.
Ifyoudonotsettheencodinghere,youarepromptedtoenterthecharacterencodingeverytimeyousetupaconnectiontoaunicode-modeHelixServer.Theencodingthatyousetheredoesnotaffectserverconnectionswhosecharacterencodinghasalreadybeensetatconnection.Ifyouareunsurewhichsettingtochoose,consultyourHelixServeradministrator.
FilesYoucanconfigurethewaytheAdministrationTooldisplaysfilesandfileicons:
n Show Perforce filetype for files in the Depot tree:Togglesdisplayoffiletypeinthetreepane.
n Show revision information for files in the Depot tree: Togglesdisplayofrevisionnumbersinthetreepane.
Application FontYoucanconfigurethefontfamily,style,andsizefortheapplicationfontandfilecontentfontthatP4Adminuses.Forfilecontent,youcanalsoselecttoShow fixed sized fonts only.SelectingthisoptionlimitsthevaluesavailableintheFont familylisttofixed-sizedfonts.
BehaviorYoucanconfigurethefollowingAdministrationTooluserinterfacebehaviors:
Drag and drop:
11
-
Tools
n on a file, do a diff comparisons:Whenselected,P4AdminlaunchestheDiffdialogwhenyoudropafileonanotherfile.
n anywhere within a changelist, move open files to new changelist:Whenselected,P4Adminmovesanyopenfilestoanewchangelistwhenyoudropafilewithinachangelist.
n on a file, do nothing:Whenselected,P4Admindoesnotdoanythingwhenyoudropafileonanotherfile.
ToolsYoucanconfigurethefollowingRevisionGraphandTime-LapseViewoptions:
Revision Graph:
n Limit Revision Graph to ancestors and descendants:Limitsafilesintegrationhistorytoancestorsanddescendants(default).Thisoptionhasthesmallestfootprintandensuresoptimizedperformance.
n Show Full Revision history in Revision Graph:Displaysthefullintegrationhistoryofthebranch.Withthisoption,therevisiongraphmighttakelongertodisplay.
Time-Lapse View:
n By default Time-lapse View should show:SpecifieswhetherTime-lapseViewdisplaystheintegration/mergehistoryfortheselectedfilebydefault.YoucanalsotogglethedisplayofintegrationhistoryinTime-lapseView.
EditorToassociatefiletypeswiththeapplicationsyouusetoeditthem:
1. ClickAdd.
2. Selectafileextensionfromthedrop-downlist.
3. Enterorbrowsefortheassociatedapplication.
4. (Optional)SelectAlways use the selected application to open files of this typetosettheapplicationasthedefault.
5. ClickSave.
Youcanenterasmanyapplicationsasyoulikeforeachextension.Alloftheapplicationswillappearasoptionswhenyouright-clickafileintheAdministrationToolandselectOpen With.
Note AnyapplicationthatyouveusedtoopenafilefromthecontextmenuintheAdministrationToolappearsbydefaultasanassociatedapplicationontheEditorpageintheAdministrationToolPreferencesdialog,unlessyouremoveit.
12
-
Diff
DiffTosetthedefaultdiffapplication,selectoneofthefollowing:
1. P4Merge: Thecompaniondifftool.
2. Other application:Browsetoyourpreferreddifftool.
Tospecifyargumentsforthird-partydiffapplications,enter%1forthenameofthefirstfileand%2forthenameofthesecondfileintheArgumentsfield.Perforcereplacestheseplaceholderswiththeactualfilenameswhencallingthediffapplication.
Toassigndiffapplicationsbyfiletype:
1. ClickAdd.
2. Selectafileextensionfromthedrop-downlist.
3. Enterorbrowsefortheassociatedapplication.
4. Specifyargumentsforthird-partydiffapplicationsintheArgumentsfield:
Enter%1forthenameofthefirstfileand%2forthenameofthesecondfile.TheAdministrationToolreplacestheseplaceholderswiththeactualfilenameswhencallingthediffapplication.
5. ClickSave.
Theextensionandassociatedapplicationaredisplayedinthelistoffiletype-applicationassociations.
AppletsYoucanenableaHelixServertoserveappletsthatcanruninP4Admin.FortheseappletstoruninP4Admin,youmustenableappletsintheP4Adminpreferences.FormoreinformationaboutPerforceapplets,seethePerforce Javascript API for Visual Tools User Guide.
ToenableappletstoruninP4Admin:
1. SelectAllow Perforce applets to run in P4Admin.
2. SpecifytheHelixServer(oneormore)fromwhichyouarewillingtoacceptPerforceapplets:
n EntertheHelixServernameorhost:portintheServerfield.
n ClickAdd.
3. ClickAdvancedtospecifythefollowingsettings:
n Save cookies from applets(ClickRemove Cookiestodeleteallapplet-generatedcookies)
n Allow applets to store data locally
n Manually configure web proxy used by applets for internet access:Enterthewebproxyaddressandport.
13
http://www.perforce.com/perforce/doc.current/manuals/p4jsapi/index.html
-
Glossary
A
access level
Apermissionassignedtoausertocontrolwhichcommandstheusercanexecute.Seealsothe'protections'entryinthisglossaryandthe'p4protect'commandintheP4CommandReference.
admin access
Anaccesslevelthatgivestheuserpermissiontoprivilegedcommands,usuallysuperprivileges.
APC
TheAlternativePHPCache,afree,open,androbustframeworkforcachingandoptimizingPHPintermediatecode.
archive
1.Forreplication,versionedfiles(asopposedtodatabasemetadata).2.Forthe'p4archive'command,aspecialdepotinwhichtocopytheserverdata(ersionedfilesandmetadata).
atomic change transaction
Groupingoperationsaffectinganumberoffilesinasingletransaction.Ifalloperationsinthetransactionsucceed,allthefilesareupdated.Ifanyoperationinthetransactionfails,noneofthefilesareupdated.
avatar
AvisualrepresentationofaSwarmuserorgroup.AvatarsareusedinSwarmtoshowinvolvementinorownershipofprojects,groups,changelists,reviews,comments,etc.Seealsothe"Gravatar"entryinthisglossary.
B
base
Thefilerevision,inconjunctionwiththesourcerevision,usedtohelpdeterminewhatintegrationchangesshouldbeappliedtothetargetrevision.
14
-
Glossary
binary file type
AHelixServerfiletypeassignedtoanon-textfile.Bydefault,thecontentsofeachrevisionarestoredinfull,andfilerevisionisstoredincompressedformat.
branch
(noun)AsetofrelatedfilesthatexistataspecificlocationinthePerforcedepotasaresultofbeingcopiedtothatlocation,asopposedtobeingaddedtothatlocation.Agroupofrelatedfilesisoftenreferredtoasacodeline.(verb)Tocreateacodelinebycopyinganothercodelinewiththe'p4integrate','p4copy',or'p4populate'command.
branch form
Theformthatappearswhenyouusethe'p4branch'commandtocreateormodifyabranchspecification.
branch mapping
Specifieshowabranchistobecreatedorintegratedbydefiningthelocation,thefiles,andtheexclusionsoftheoriginalcodelineandthetargetcodeline.Thebranchmappingisusedbytheintegrationprocesstocreateandupdatebranches.
branch view
Aspecificationofthebranchingrelationshipbetweentwocodelinesinthedepot.Eachbranchviewhasauniquenameanddefineshowfilesaremappedfromtheoriginatingcodelinetothetargetcodeline.Thisisthesameasbranchmapping.
broker
HelixBroker,aserverprocessthatinterceptscommandstotheHelixServerandisabletorunscriptsonthecommandsbeforesendingthemtotheHelixServer.
C
change review
Theprocessofsendingemailtouserswhohaveregisteredtheirinterestinchangeliststhatincludespecifiedfilesinthedepot.
changelist
Alistoffiles,theirversionnumbers,thechangesmadetothefiles,andadescriptionofthechangesmade.AchangelististhebasicunitofversionedworkinHelixServer.Thechangesspecifiedinthe
15
-
Glossary
changelistarenotstoredinthedepotuntilthechangelistissubmittedtothedepot.Seealsoatomicchangetransaction.
changelist form
Theformthatappearswhenyoumodifyachangelistusingthe'p4change'command.
changelist number
Theuniquenumericidentifierofachangelist.Bydefault,changelistsaresequential.
check in
TosubmitafiletotheHelixServerdepot.
check out
Todesignateoneormorefilesforedit.
checkpoint
Abackupcopyoftheunderlyingmetadataataparticularmomentintime.Acheckpointcanrecreatedb.user,db.protect,andotherdb.*files.Seealsometadata.
classic depot
ArepositoryofHelixServerfilesthatisnotstreams-based.Thedefaultdepotnameisdepot.Seealsodefaultdepotandstreamdepot.
client form
Theformyouusetodefineaclientworkspace,suchaswiththe'p4client'or'p4workspace'commands.
client name
Anamethatuniquelyidentifiesthecurrentclientworkspace.Clientworkspaces,labels,andbranchspecificationscannotsharethesamename.
client root
Thetopmost(root)directoryofaclientworkspace.Iftwoormoreclientworkspacesarelocatedononemachine,theyshouldnotshareaclientrootdirectory.
16
-
Glossary
client side
Theright-handsideofamappingwithinaclientview,specifyingwherethecorrespondingdepotfilesarelocatedintheclientworkspace.
client workspace
DirectoriesonyourmachinewhereyouworkonfilerevisionsthataremanagedbyHelixServer.Bydefault,thisnameissettothenameofthemachineonwhichyourclientworkspaceislocated,butitcanbeoverridden.Clientworkspaces,labels,andbranchspecificationscannotsharethesamename.
code review
AprocessinHelixSwarmbywhichotherdeveloperscanseeyourcode,providefeedback,andapproveorrejectyourchanges.
codeline
Asetoffilesthatevolvecollectively.Onecodelinecanbebranchedfromanother,allowingeachsetoffilestoevolveseparately.
comment
FeedbackprovidedinHelixSwarmonachangelist,review,job,orafilewithinachangelistorreview.
commit server
Aserverthatispartofanedge/commitsystemthatprocessessubmittedfiles(checkins),globalworkspaces,andpromotedshelves.
conflict
1.Asituationwheretwousersopenthesamefileforedit.Oneusersubmitsthefile,afterwhichtheotherusercannotsubmitunlessthefileisresolved.2.Aresolvewherethesamelineischangedwhenmergingonefileintoanother.Thistypeofconflictoccurswhenthecomparisonoftwofilestoabaseyieldsdifferentresults,indicatingthatthefileshavebeenchangedindifferentways.Inthiscase,themergecannotbedoneautomaticallyandmustberesolvedmanually.Seefileconflict.
copy up
AHelixServerbestpracticetocopy(andnotmerge)changesfromlessstablelinestomorestablelines.Seealsomerge.
17
-
Glossary
counter
Anumericvariableusedtotrackvariablessuchaschangelists,checkpoints,andreviews.
CSRF
Cross-SiteRequestForgery,aformofweb-basedattackthatexploitsthetrustthatasitehasinauser'swebbrowser.
D
default changelist
Thechangelistusedbyafileadd,edit,ordelete,unlessanumberedchangelistisspecified.Adefaultpendingchangelistiscreatedautomaticallywhenafileisopenedforedit.
deleted file
InHelixServer,afilewithitsheadrevisionmarkedasdeleted.Olderrevisionsofthefilearestillavailable.inHelixServer,adeletedfileissimplyanotherrevisionofthefile.
delta
Thedifferencesbetweentwofiles.
depot
Afilerepositoryhostedontheserver.Adepotisthetop-levelunitofstorageforversionedfiles(depotfilesorsourcefiles)withinaHelixVersioningEngine.Itcontainsallversionsofallfileseversubmittedtothedepot.Therecanbemultipledepotsonasingleinstallation.
depot root
Thetopmost(root)directoryforadepot.
depot side
Theleftsideofanyclientviewmapping,specifyingthelocationoffilesinadepot.
depot syntax
HelixServersyntaxforspecifyingthelocationoffilesinthedepot.Depotsyntaxbeginswith://depot/
18
-
Glossary
diff
(noun)Asetoflinesthatdonotmatchwhentwofilesarecompared.Aconflictisapairofunequaldiffsbetweeneachoftwofilesandabase.(verb)Tocomparethecontentsoffilesorfilerevisions.Seealsoconflict.
donor file
Thefilefromwhichchangesaretakenwhenpropagatingchangesfromonefiletoanother.
E
edge server
Areplicaserverthatispartofanedge/commitsystemthatisabletoprocessmostread/writecommands,including'p4integrate',andalsodeliverversionedfiles(depotfiles).
exclusionary access
Apermissionthatdeniesaccesstothespecifiedfiles.
exclusionary mapping
Aviewmappingthatexcludesspecificfilesordirectories.
F
file conflict
Inathree-wayfilemerge,asituationinwhichtworevisionsofafiledifferfromeachotherandfromtheirbasefile.Also,anattempttosubmitafilethatisnotaneditoftheheadrevisionofthefileinthedepot,whichtypicallyoccurswhenanotheruseropensthefileforeditafteryouhaveopenedthefileforedit.
file pattern
HelixServercommandlinesyntaxthatenablesyoutospecifyfilesusingwildcards.
file repository
Themastercopyofallfiles,whichissharedbyallusers.InHelixServer,thisiscalledthedepot.
19
-
Glossary
file revision
Aspecificversionofafilewithinthedepot.Eachrevisionisassignedanumber,insequence.Anyrevisioncanbeaccessedinthedepotbyitsrevisionnumber,precededbyapoundsign(#),forexampletestfile#3.
file tree
Allthesubdirectoriesandfilesunderagivenrootdirectory.
file type
AnattributethatdetermineshowHelixServerstoresanddiffsaparticularfile.Examplesoffiletypesaretextandbinary.
fix
Ajobthathasbeenclosedinachangelist.
form
AscreendisplayedbycertainHelixServercommands.Forexample,youusethechangeformtoentercommentsaboutaparticularchangelisttoverifytheaffectedfiles.
forwarding replica
Areplicaserverthatcanprocessread-onlycommandsanddeliverversionedfiles(depotfiles).Oneormorereplicatserverscansignificantlyimproveperformancebyoffloadingsomeofthemasterserverload.Inmanycases,aforwardingreplicacanbecomeadisasterrecoveryserver.
G
Git Fusion
APerforceproductthatintegratesGitwithHelix,offeringenterprise-readyGitrepositorymanagement,andworkflowsthatallowGitandHelixServeruserstocollaborateonthesameprojectsusingtheirpreferredtools.
graph depot
AdepotoftypegraphthatisusedtostoreGitreposintheHelixServer.SeealsoHelix4Git.
20
-
Glossary
Gravatar
gravatar.comisathirdpartyservicethatyoucansubscribeto,gravatarenablesyoutouploadanimagethatyoucanuseinSwarm.Whenconfigured,Swarmwillattempttofetchyouravatarfromgravatar.comanduseitwithinSwarm.Ifyouravatarisnotfoundongravatar.com,Swarmwilluseoneofitsowndefaultavatarstorepresentyouractivity.Seealsothe"avatar"entryinthisglossary.
group
AfeatureinHelixServerthatmakesiteasiertomanagepermissionsformultipleusers.
H
have list
Thelistoffilerevisionscurrentlyintheclientworkspace.
head revision
Themostrecentrevisionofafilewithinthedepot.Becausefilerevisionsarenumberedsequentially,thisrevisionisthehighest-numberedrevisionofthatfile.
Helix Server
TheHelixServerdepotandmetadata;also,theprogramthatmanagesthedepotandmetadata,alsocalledHelixVersioningEngine.
Helix TeamHub
APerforcemanagementplatformforcodeandartifactrepository.TeamHuboffersbuilt-insupportforGit,SVN,Mercurial,Maven,andmore.
Helix4Git
PerforcesolutionforteamsusingGit.Helix4GitoffersbothspeedandscalabilityandsupportshybridenvironmentsconsistingofGitrepositoriesand'classic'HelixServerdepots.
I
iconv
iconvisaPHPextensionthatperformscharactersetconversion,andisaninterfacetotheGNUlibiconvlibrary.
21
-
Glossary
integrate
Tocomparetwosetsoffiles(forexample,twocodelinebranches)anddeterminewhichchangesinonesetapplytotheother,determineifthechangeshavealreadybeenpropagated,andpropagateanyoutstandingchangesfromonesettoanother.
J
job
Auser-definedunitofworktrackedbyHelixServer.Thejobtemplatedetermineswhatinformationistracked.ThetemplatecanbemodifiedbytheHelixServersystemadministrator.Ajobdescribesworktobedone,suchasabugfix.Associatingajobwithachangelistrecordswhichchangesfixedthebug.
job daemon
AjobdaemonisaprogramthatcheckstheHelixServermachinedailytodetermineifanyjobsareopen.Ifso,thedaemonsendsanemailmessagetointerestedusers,informingthemthenumberofjobsineachcategory,theseverityofeachjob,andmore.
job specification
AformdescribingthefieldsandpossiblevaluesforeachjobstoredintheHelixServermachine.
job view
AsyntaxusedforsearchingHelixServerjobs.
journal
AfilecontainingarecordofeverychangemadetotheHelixServersmetadatasincethetimeofthelastcheckpoint.ThisfilegrowsaseachHelixServertransactionislogged.Thefileshouldbeautomaticallytruncatedandrenamedintoanumberedjournalwhenacheckpointistaken.
journal rotation
Theprocessofrenamingthecurrentjournaltoanumberedjournalfile.
journaling
TheprocessofrecordingchangesmadetotheHelixServersmetadata.
22
-
Glossary
L
label
Anamedlistofuser-specifiedfilerevisions.
label view
Theviewthatspecifieswhichfilenamesinthedepotcanbestoredinaparticularlabel.
lazy copy
AmethodusedbyHelixServertomakeinternalcopiesoffileswithoutduplicatingfilecontentinthedepot.Alazycopypointstotheoriginalversionedfile(depotfile).Lazycopiesminimizetheconsumptionofdiskspacebystoringreferencestotheoriginalfileinsteadofcopiesofthefile.
license file
AfilethatensuresthatthenumberofHelixServerusersonyoursitedoesnotexceedthenumberforwhichyouhavepaid.
list access
Aprotectionlevelthatenablesyoutorunreportingcommandsbutpreventsaccesstothecontentsoffiles.
local depot
AnydepotlocatedonthecurrentlyspecifiedHelixServer.
local syntax
Thesyntaxforspecifyingafilenamethatisspecifictoanoperatingsystem.
lock
1.Afilelockthatpreventsotherclientsfromsubmittingthelockedfile.Filesareunlockedwiththe'p4unlock'commandorbysubmittingthechangelistthatcontainsthelockedfile.2.Adatabaselockthatpreventsanotherprocessfrommodifyingthedatabasedb.*file.
log
ErroroutputfromtheHelixServer.Tospecifyalogfile,settheP4LOGenvironmentvariableorusethep4d-Lflagwhenstartingtheservice.
23
-
Glossary
M
mapping
Asinglelineinaview,consistingofaleftsideandarightsidethatspecifythecorrespondencesbetweenfilesinthedepotandfilesinaclient,label,orbranch.Seealsoworkspaceview,branchview,andlabelview.
MDS checksum
ThemethodusedbyHelixServertoverifytheintegrityofversionedfiles(depotfiles).
merge
1.Tocreatenewfilesfromexistingfiles,preservingtheirancestry(branching).2.Topropagatechangesfromonesetoffilestoanother.3.Theprocessofcombiningthecontentsoftwoconflictingfilerevisionsintoasinglefile,typicallyusingamergetoollikeP4Merge.
merge file
AfilegeneratedbytheHelixServerfromtwoconflictingfilerevisions.
metadata
ThedatastoredbytheHelixServerthatdescribesthefilesinthedepot,thecurrentstateofclientworkspaces,protections,users,labels,andbranches.MetadataincludesallthedatastoredinthePerforceserviceexceptfortheactualcontentsofthefiles.
modification time or modtime
Thetimeafilewaslastchanged.
MPM
Multi-ProcessingModule,acomponentoftheApachewebserverthatisresponsibleforbindingtonetworkports,acceptingrequests,anddispatchoperationstohandletherequest.
N
nonexistent revision
Acompletelyemptyrevisionofanyfile.Syncingtoanonexistentrevisionofafileremovesitfromyourworkspace.Anemptyfilerevisioncreatedbydeletingafileandthe#nonerevisionspecifierareexamplesofnonexistentfilerevisions.
24
-
Glossary
numbered changelist
ApendingchangelisttowhichHelixServerhasassignedanumber.
O
opened file
Afilethatyouarechanginginyourclientworkspacethatischeckedout.Ifthefileisnotcheckedout,openingitinthefilesystemdoesnotmeananythingtotheversioningengineer.
owner
TheHelixServeruserwhocreatedaparticularclient,branch,orlabel.
P
p4
1.TheHelixVersioningEnginecommandlineprogram.2.Thecommandyouissuetoexecutecommandsfromtheoperatingsystemcommandline.
p4d
TheprogramthatrunstheHelixServer;p4dmanagesdepotfilesandmetadata.
P4PHP
ThePHPinterfacetotheHelixAPI,whichenablesyoutowritePHPcodethatinteractswithaHelixServermachine.
PECL
PHPExtensionCommunityLibrary,alibraryofextensionsthatcanbeaddedtoPHPtoimproveandextenditsfunctionality.
pending changelist
Achangelistthathasnotbeensubmitted.
project
InHelixSwarm,agroupofHelixServeruserswhoareworkingtogetheronaspecificcodebase,definedbyoneormorebranchesofcode,alongwithoptionsforajobfilter,automatedtest
25
-
Glossary
integration,andautomateddeployment.
protections
ThepermissionsstoredintheHelixServersprotectionstable.
proxy server
AHelixServerthatstoresversionedfiles.Aproxyserverdoesnotperformanycommands.ItservesversionedfilestoHelixServerclients.
R
RCS format
RevisionControlSystemformat.Usedforstoringrevisionsoftextfilesinversionedfiles(depotfiles).RCSformatusesreversedeltaencodingforfilestorage.HelixServerusesRCSformattostoretextfiles.Seealsoreversedeltastorage.
read access
AprotectionlevelthatenablesyoutoreadthecontentsoffilesmanagedbyHelixServerbutnotmakeanychanges.
remote depot
AdepotlocatedonanotherHelixServeraccessedbythecurrentHelixServer.
replica
AHelixServerthatcontainsafullorpartialcopyofmetadatafromamasterHelixServer.Replicaserversaretypicallyupdatedeverysecondtostaysynchronizedwiththemasterserver.
repo
Agraphdepotcontainsoneormorerepos,andeachrepocontainsfilesfromGitusers.
reresolve
Theprocessofresolvingafileafterthefileisresolvedandbeforeitissubmitted.
resolve
Theprocessyouusetomanagethedifferencesbetweentworevisionsofafile.Youcanchoosetoresolveconflictsbyselectingthesourceortargetfiletobesubmitted,bymergingthecontentsof
26
-
Glossary
conflictingfiles,orbymakingadditionalchanges.
reverse delta storage
ThemethodthatHelixServerusestostorerevisionsoftextfiles.HelixServerstoresthechangesbetweeneachrevisionanditspreviousrevision,plusthefulltextoftheheadrevision.
revert
Todiscardthechangesyouhavemadetoafileintheclientworkspacebeforeasubmit.
review access
Aspecialprotectionslevelthatincludesreadandlistaccessesandgrantspermissiontorunthep4reviewcommand.
review daemon
AreviewdaemonisaprogramthatperiodicallycheckstheHelixServermachinetodetermineifanychangelistshavebeensubmitted.Ifso,thedaemonsendsanemailmessagetouserswhohavesubscribedtoanyofthefilesincludedinthosechangelists,informingthemofchangesinfilestheyareinterestedin.
revision number
Anumberindicatingwhichrevisionofthefileisbeingreferredto,typicallydesignatedwithapoundsign(#).
revision range
Arangeofrevisionnumbersforaspecifiedfile,specifiedasthelowandhighendoftherange.Forexample,myfile#5,7specifiesrevisions5through7ofmyfile.
revision specification
Asuffixtoafilenamethatspecifiesaparticularrevisionofthatfile.Revisionspecifierscanberevisionnumbers,arevisionrange,changenumbers,labelnames,date/timespecifications,orclientnames.
RPM
RPMPackageManagerisatool,andpackageformat,formanagingtheinstallation,updates,andremovalofsoftwarepackagesforLinuxdistributionssuchasRedHatEnterpriseLinux,theFedoraProject,andtheCentOSProject.
27
-
Glossary
S
server data
Thecombinationofservermetadata(theHelixServerdatabase)andthedepotfiles(yourorganization'sversionedsourcecodeandbinaryassets).
server root
Thetopmostdirectoryinwhichp4dstoresitsmetadata(db.*files)andallversionedfiles(depotfilesorsourcefiles).Tospecifytheserverroot,settheP4ROOTenvironmentvariableorusethep4d-rflag.
service
IntheHelixVersioningEngine,thesharedversioningservicethatrespondstorequestsfromHelixServerclientapplications.TheHelixServer(p4d)maintainsdepotfilesandmetadatadescribingthefilesandalsotracksthestateofclientworkspaces.
shelve
TheprocessoftemporarilystoringfilesintheHelixServerwithoutcheckinginachangelist.
status
Forachangelist,avaluethatindicateswhetherthechangelistisnew,pending,orsubmitted.Forajob,avaluethatindicateswhetherthejobisopen,closed,orsuspended.Youcancustomizejobstatuses.Forthe'p4status'command,bydefaultthefilesopenedandthefilesthatneedtobereconciled.
stream
Abranchwithadditionalintelligencethatdetermineswhatchangesshouldbepropagatedandinwhatordertheyshouldbepropagated.
stream depot
Adepotusedwithstreamsandstreamclients.
submit
TosendapendingchangelistintotheHelixServerdepotforprocessing.
28
-
Glossary
super access
AnaccesslevelthatgivestheuserpermissiontoruneveryHelixServercommand,includingcommandsthatsetprotections,installtriggers,orshutdowntheserviceformaintenance.
symlink file type
AHelixServerfiletypeassignedtosymboliclinks.Onplatformsthatdonotsupportsymboliclinks,symlinkfilesappearassmalltextfiles.
sync
Tocopyafilerevision(orsetoffilerevisions)fromtheHelixServerdepottoaclientworkspace.
T
target file
Thefilethatreceivesthechangesfromthedonorfilewhenyouintegratechangesbetweentwocodelines.
text file type
HelixServerfiletypeassignedtoafilethatcontainsonlyASCIItext,includingUnicodetext.Seealsobinaryfiletype.
theirs
Therevisioninthedepotwithwhichtheclientfile(yourfile)ismergedwhenyouresolveafileconflict.Whenyouareworkingwithbranchedfiles,theirsisthedonorfile.
three-way merge
Theprocessofcombiningthreefilerevisions.Duringathree-waymerge,youcanidentifywhereconflictingchangeshaveoccurredandspecifyhowyouwanttoresolvetheconflicts.
trigger
AscriptautomaticallyinvokedbyHelixServerwhenvariousconditionsaremet.(See"HelixVersioningEngineAdministratorGuide:Fundamentals"on"Usingtriggerstocustomizebehavior")
two-way merge
Theprocessofcombiningtwofilerevisions.Inatwo-waymerge,youcanseedifferencesbetweenthefiles.
29
-
Glossary
typemap
AtableinHelixServerinwhichyouassignfiletypestofiles.
U
user
TheidentifierthatHelixServerusestodeterminewhoisperforminganoperation.
V
versioned file
SourcefilesstoredintheHelixServerdepot,includingoneormorerevisions.Alsoknownasadepotfileorsourcefile.Versionedfilestypicallyusethenamingconvention'filenamev'or'1.changelist.gz'.
view
Adescriptionoftherelationshipbetweentwosetsoffiles.Seeworkspaceview,labelview,branchview.
W
wildcard
Aspecialcharacterusedtomatchothercharactersinstrings.ThefollowingwildcardsareavailableinHelixServer:*matchesanythingexceptaslash;...matchesanythingincludingslashes;%%0through%%9isusedforparametersubstitutioninviews.
workspace
Seeclientworkspace.
workspace view
Asetofmappingsthatspecifiesthecorrespondencebetweenfilelocationsinthedepotandtheclientworkspace.
write access
Aprotectionlevelthatenablesyoutoruncommandsthatalterthecontentsoffilesinthedepot.Writeaccessincludesreadandlistaccesses.
30
-
Glossary
X
XSS
Cross-SiteScripting,aformofweb-basedattackthatinjectsmaliciouscodeintoauser'swebbrowser.
Y
yours
Theeditedversionofafileinyourclientworkspacewhenyouresolveafile.Also,thetargetfilewhenyouintegrateabranchedfile.
31
-
License statementsPerforceSoftwareincludessoftwaredevelopedbytheUniversityofCalifornia,Berkeleyanditscontributors.ThisproductincludessoftwaredevelopedbytheOpenSSLProjectforuseintheOpenSSLToolkit(http://www.openssl.org/).
PerforceSoftwareincludessoftwarefromtheApacheZooKeeperproject,developedbytheApacheSoftwareFoundationanditscontributors.(http://zookeeper.apache.org/)
PerforceSoftwareincludessoftwaredevelopedbytheOpenLDAPFoundation(http://www.openldap.org/).
32
http://www.openssl.org/http://zookeeper.apache.org/http://www.openldap.org/
How to use this guideFeedbackOther documentationSyntax conventions
Administering Helix Server using P4AdminHome pageServer connectionsManaging depotsManaging users and groupsManaging permissionsView permissionsEdit the protections table
Configuring P4Admin preferencesConnectionsServer DataLoggingDisplayFilesApplication FontBehaviorToolsEditorDiffApplets
GlossaryLicense statements