ref-variables.xml 757 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872
  1. <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  2. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
  3. [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
  4. <!-- Dummy chapter -->
  5. <chapter id='ref-variables-glos'>
  6. <title>Variables Glossary</title>
  7. <para>
  8. This chapter lists common variables used in the OpenEmbedded build system and gives an overview
  9. of their function and contents.
  10. </para>
  11. <glossary id='ref-variables-glossary'>
  12. <para>
  13. <link linkend='var-ABIEXTENSION'>A</link>
  14. <link linkend='var-B'>B</link>
  15. <link linkend='var-CACHE'>C</link>
  16. <link linkend='var-D'>D</link>
  17. <link linkend='var-EFI_PROVIDER'>E</link>
  18. <link linkend='var-FEATURE_PACKAGES'>F</link>
  19. <link linkend='var-GDB'>G</link>
  20. <link linkend='var-HOMEPAGE'>H</link>
  21. <link linkend='var-ICECC_DISABLED'>I</link>
  22. <!-- <link linkend='var-glossary-j'>J</link> -->
  23. <link linkend='var-KARCH'>K</link>
  24. <link linkend='var-LABELS'>L</link>
  25. <link linkend='var-MACHINE'>M</link>
  26. <!-- <link linkend='var-glossary-n'>N</link> -->
  27. <link linkend='var-OBJCOPY'>O</link>
  28. <link linkend='var-P'>P</link>
  29. <!-- <link linkend='var-glossary-q'>Q</link> -->
  30. <link linkend='var-RANLIB'>R</link>
  31. <link linkend='var-S'>S</link>
  32. <link linkend='var-T'>T</link>
  33. <link linkend='var-UBOOT_CONFIG'>U</link>
  34. <!-- <link linkend='var-glossary-v'>V</link> -->
  35. <link linkend='var-WARN_QA'>W</link>
  36. <link linkend='var-XSERVER'>X</link>
  37. <!-- <link linkend='var-glossary-y'>Y</link> -->
  38. <!-- <link linkend='var-glossary-z'>Z</link>-->
  39. </para>
  40. <glossdiv id='var-glossary-a'><title>A</title>
  41. <glossentry id='var-ABIEXTENSION'><glossterm>ABIEXTENSION</glossterm>
  42. <info>
  43. ABIEXTENSION[doc] = "Extension to the Application Binary Interface (ABI) field of the GNU canonical architecture name (e.g. "eabi")."
  44. </info>
  45. <glossdef>
  46. <para role="glossdeffirst">
  47. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  48. Extension to the Application Binary Interface (ABI)
  49. field of the GNU canonical architecture name
  50. (e.g. "eabi").
  51. </para>
  52. <para>
  53. ABI extensions are set in the machine include files.
  54. For example, the
  55. <filename>meta/conf/machine/include/arm/arch-arm.inc</filename>
  56. file sets the following extension:
  57. <literallayout class='monospaced'>
  58. ABIEXTENSION = "eabi"
  59. </literallayout>
  60. </para>
  61. </glossdef>
  62. </glossentry>
  63. <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm>
  64. <info>
  65. ALLOW_EMPTY[doc] = "Specifies if an output package should still be produced if it is empty."
  66. </info>
  67. <glossdef>
  68. <para role="glossdeffirst">
  69. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  70. Specifies if an output package should still be produced if it is empty.
  71. By default, BitBake does not produce empty packages.
  72. This default behavior can cause issues when there is an
  73. <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or
  74. some other hard runtime requirement on the existence of the package.
  75. </para>
  76. <para>
  77. Like all package-controlling variables, you must always use them in
  78. conjunction with a package name override, as in:
  79. <literallayout class='monospaced'>
  80. ALLOW_EMPTY_${PN} = "1"
  81. ALLOW_EMPTY_${PN}-dev = "1"
  82. ALLOW_EMPTY_${PN}-staticdev = "1"
  83. </literallayout>
  84. </para>
  85. </glossdef>
  86. </glossentry>
  87. <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm>
  88. <info>
  89. ALTERNATIVE[doc] = "Lists commands in a package that need an alternative binary naming scheme."
  90. </info>
  91. <glossdef>
  92. <para role="glossdeffirst">
  93. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  94. Lists commands in a package that need an alternative
  95. binary naming scheme.
  96. Sometimes the same command is provided in multiple packages.
  97. When this occurs, the OpenEmbedded build system needs to
  98. use the alternatives system to create a different binary
  99. naming scheme so the commands can co-exist.
  100. </para>
  101. <para>
  102. To use the variable, list out the package's commands
  103. that also exist as part of another package.
  104. For example, if the <filename>busybox</filename> package
  105. has four commands that also exist as part of another
  106. package, you identify them as follows:
  107. <literallayout class='monospaced'>
  108. ALTERNATIVE_busybox = "sh sed test bracket"
  109. </literallayout>
  110. For more information on the alternatives system, see the
  111. "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>"
  112. section.
  113. </para>
  114. </glossdef>
  115. </glossentry>
  116. <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm>
  117. <info>
  118. ALTERNATIVE_LINK_NAME[doc] = "Used by the alternatives system to map duplicated commands to actual locations."
  119. </info>
  120. <glossdef>
  121. <para role="glossdeffirst">
  122. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  123. Used by the alternatives system to map duplicated commands
  124. to actual locations.
  125. For example, if the <filename>bracket</filename> command
  126. provided by the <filename>busybox</filename> package is
  127. duplicated through another package, you must use the
  128. <filename>ALTERNATIVE_LINK_NAME</filename> variable to
  129. specify the actual location:
  130. <literallayout class='monospaced'>
  131. ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/["
  132. </literallayout>
  133. </para>
  134. <para>
  135. In this example, the binary for the
  136. <filename>bracket</filename> command (i.e.
  137. <filename>[</filename>) from the
  138. <filename>busybox</filename> package resides in
  139. <filename>/usr/bin/</filename>.
  140. <note>
  141. If <filename>ALTERNATIVE_LINK_NAME</filename> is not
  142. defined, it defaults to
  143. <filename>${bindir}/<replaceable>name</replaceable></filename>.
  144. </note>
  145. </para>
  146. <para>
  147. For more information on the alternatives system, see the
  148. "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>"
  149. section.
  150. </para>
  151. </glossdef>
  152. </glossentry>
  153. <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm>
  154. <info>
  155. ALTERNATIVE_PRIORITY[doc] = "Used by the alternatives system to create default priorities for duplicated commands."
  156. </info>
  157. <glossdef>
  158. <para role="glossdeffirst">
  159. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  160. Used by the alternatives system to create default
  161. priorities for duplicated commands.
  162. You can use the variable to create a single default
  163. regardless of the command name or package, a default for
  164. specific duplicated commands regardless of the package, or
  165. a default for specific commands tied to particular packages.
  166. Here are the available syntax forms:
  167. <literallayout class='monospaced'>
  168. ALTERNATIVE_PRIORITY = "<replaceable>priority</replaceable>"
  169. ALTERNATIVE_PRIORITY[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>"
  170. ALTERNATIVE_PRIORITY_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>"
  171. </literallayout>
  172. </para>
  173. <para>
  174. For more information on the alternatives system, see the
  175. "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>"
  176. section.
  177. </para>
  178. </glossdef>
  179. </glossentry>
  180. <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm>
  181. <info>
  182. ALTERNATIVE_TARGET[doc] = "Used by the alternatives system to create default link locations for duplicated commands."
  183. </info>
  184. <glossdef>
  185. <para role="glossdeffirst">
  186. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  187. Used by the alternatives system to create default link
  188. locations for duplicated commands.
  189. You can use the variable to create a single default
  190. location for all duplicated commands regardless of the
  191. command name or package, a default for
  192. specific duplicated commands regardless of the package, or
  193. a default for specific commands tied to particular packages.
  194. Here are the available syntax forms:
  195. <literallayout class='monospaced'>
  196. ALTERNATIVE_TARGET = "<replaceable>target</replaceable>"
  197. ALTERNATIVE_TARGET[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>"
  198. ALTERNATIVE_TARGET_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>"
  199. </literallayout>
  200. <note>
  201. <para>
  202. If <filename>ALTERNATIVE_TARGET</filename> is not
  203. defined, it inherits the value from the
  204. <link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link>
  205. variable.
  206. </para>
  207. <para>
  208. If <filename>ALTERNATIVE_LINK_NAME</filename> and
  209. <filename>ALTERNATIVE_TARGET</filename> are the
  210. same, the target for
  211. <filename>ALTERNATIVE_TARGET</filename>
  212. has "<filename>.{BPN}</filename>" appended to it.
  213. </para>
  214. <para>
  215. Finally, if the file referenced has not been
  216. renamed, the alternatives system will rename it to
  217. avoid the need to rename alternative files in the
  218. <link linkend='ref-tasks-install'><filename>do_install</filename></link>
  219. task while
  220. retaining support for the command if necessary.
  221. </para>
  222. </note>
  223. </para>
  224. <para>
  225. For more information on the alternatives system, see the
  226. "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>"
  227. section.
  228. </para>
  229. </glossdef>
  230. </glossentry>
  231. <glossentry id='var-APPEND'><glossterm>APPEND</glossterm>
  232. <info>
  233. APPEND[doc] = "An override list of append strings for each LABEL."
  234. </info>
  235. <glossdef>
  236. <para role="glossdeffirst">
  237. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  238. An override list of append strings for each
  239. <link linkend='var-LABELS'><filename>LABEL</filename></link>.
  240. </para>
  241. <para>
  242. See the
  243. <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link>
  244. class for more information on how this variable is used.
  245. </para>
  246. </glossdef>
  247. </glossentry>
  248. <glossentry id='var-AR'><glossterm>AR</glossterm>
  249. <info>
  250. AR[doc] = "Minimal command and arguments to run 'ar'."
  251. </info>
  252. <glossdef>
  253. <para role="glossdeffirst">
  254. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  255. The minimal command and arguments used to run
  256. <filename>ar</filename>.
  257. </para>
  258. </glossdef>
  259. </glossentry>
  260. <glossentry id='var-ARCHIVER_MODE'><glossterm>ARCHIVER_MODE</glossterm>
  261. <info>
  262. ARCHIVER_MODE[doc] = "Controls archive creation used when releasing source files."
  263. </info>
  264. <glossdef>
  265. <para role="glossdeffirst">
  266. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  267. When used with the
  268. <link linkend='ref-classes-archiver'><filename>archiver</filename></link>
  269. class, determines the type of information used to create
  270. a released archive.
  271. You can use this variable to create archives of patched
  272. source, original source, configured source, and so forth
  273. by employing the following variable flags (varflags):
  274. <literallayout class='monospaced'>
  275. ARCHIVER_MODE[src] = "original" # Uses original (unpacked) source
  276. # files.
  277. ARCHIVER_MODE[src] = "patched" # Uses patched source files. This is
  278. # the default.
  279. ARCHIVER_MODE[src] = "configured" # Uses configured source files.
  280. ARCHIVER_MODE[diff] = "1" # Uses patches between do_unpack and
  281. # do_patch.
  282. ARCHIVER_MODE[diff-exclude] ?= "<replaceable>file</replaceable> <replaceable>file</replaceable> ..." # Lists files and directories to
  283. # exclude from diff.
  284. ARCHIVER_MODE[dumpdata] = "1" # Uses environment data.
  285. ARCHIVER_MODE[recipe] = "1" # Uses recipe and include files.
  286. ARCHIVER_MODE[srpm] = "1" # Uses RPM package files.
  287. </literallayout>
  288. For information on how the variable works, see the
  289. <filename>meta/classes/archiver.bbclass</filename> file
  290. in the
  291. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  292. </para>
  293. </glossdef>
  294. </glossentry>
  295. <glossentry id='var-AS'><glossterm>AS</glossterm>
  296. <info>
  297. AS[doc] = "Minimal command and arguments to run the assembler."
  298. </info>
  299. <glossdef>
  300. <para role="glossdeffirst">
  301. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  302. The minimal command and arguments used to run the
  303. assembler.
  304. </para>
  305. </glossdef>
  306. </glossentry>
  307. <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm>
  308. <info>
  309. ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build."
  310. </info>
  311. <glossdef>
  312. <para role="glossdeffirst">
  313. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  314. Lists recipe names
  315. (<link linkend='var-PN'><filename>PN</filename></link>
  316. values) BitBake does not attempt to build.
  317. Instead, BitBake assumes these recipes have already been
  318. built.
  319. </para>
  320. <para>
  321. In OpenEmbedded Core, <filename>ASSUME_PROVIDED</filename>
  322. mostly specifies native tools that should not be built.
  323. An example is <filename>git-native</filename>, which when
  324. specified, allows for the Git binary from the host to be
  325. used rather than building <filename>git-native</filename>.
  326. </para>
  327. </glossdef>
  328. </glossentry>
  329. <glossentry id='var-ASSUME_SHLIBS'><glossterm>ASSUME_SHLIBS</glossterm>
  330. <info>
  331. ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system."
  332. </info>
  333. <glossdef>
  334. <para role="glossdeffirst">
  335. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  336. Provides additional <filename>shlibs</filename> provider
  337. mapping information, which adds to or overwrites the
  338. information provided automatically by the system.
  339. Separate multiple entries using spaces.
  340. </para>
  341. <para>
  342. As an example, use the following form to add an
  343. <filename>shlib</filename> provider of
  344. <replaceable>shlibname</replaceable> in
  345. <replaceable>packagename</replaceable> with the optional
  346. <replaceable>version</replaceable>:
  347. <literallayout class='monospaced'>
  348. <replaceable>shlibname:packagename</replaceable>[_<replaceable>version</replaceable>]
  349. </literallayout>
  350. </para>
  351. <para>
  352. Here is an example that adds a shared library named
  353. <filename>libEGL.so.1</filename> as being provided by
  354. the <filename>libegl-implementation</filename> package:
  355. <literallayout class='monospaced'>
  356. ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation"
  357. </literallayout>
  358. </para>
  359. </glossdef>
  360. </glossentry>
  361. <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
  362. <info>
  363. AUTHOR[doc] = "Email address used to contact the original author or authors in order to send patches and forward bugs."
  364. </info>
  365. <glossdef>
  366. <para role="glossdeffirst">
  367. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  368. The email address used to contact the original author
  369. or authors in order to send patches and forward bugs.
  370. </para>
  371. </glossdef>
  372. </glossentry>
  373. <glossentry id='var-AUTO_LIBNAME_PKGS'><glossterm>AUTO_LIBNAME_PKGS</glossterm>
  374. <info>
  375. AUTO_LIBNAME_PKGS[doc] = "Specifies which packages should be checked for libraries and renamed according to Debian library package naming."
  376. </info>
  377. <glossdef>
  378. <para role="glossdeffirst">
  379. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  380. When the
  381. <link linkend='ref-classes-debian'><filename>debian</filename></link>
  382. class is inherited, which is the default behavior,
  383. <filename>AUTO_LIBNAME_PKGS</filename> specifies which
  384. packages should be checked for libraries and renamed
  385. according to Debian library package naming.
  386. </para>
  387. <para>
  388. The default value is "${PACKAGES}", which causes the
  389. debian class to act on all packages that are
  390. explicitly generated by the recipe.
  391. </para>
  392. </glossdef>
  393. </glossentry>
  394. <glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm>
  395. <info>
  396. AUTO_SYSLINUXMENU[doc] = "Enables creating an automatic menu for the syslinux bootloader."
  397. </info>
  398. <glossdef>
  399. <para role="glossdeffirst">
  400. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  401. Enables creating an automatic menu for the syslinux
  402. bootloader.
  403. You must set this variable in your recipe.
  404. The
  405. <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
  406. class checks this variable.
  407. </para>
  408. </glossdef>
  409. </glossentry>
  410. <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
  411. <info>
  412. AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest source revision in the repository."
  413. </info>
  414. <glossdef>
  415. <para role="glossdeffirst">
  416. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  417. When
  418. <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
  419. is set to the value of this variable, it specifies to use
  420. the latest source revision in the repository.
  421. Here is an example:
  422. <literallayout class='monospaced'>
  423. SRCREV = "${AUTOREV}"
  424. </literallayout>
  425. </para>
  426. <para>
  427. If you use the previous statement to retrieve the latest
  428. version of software, you need to be sure
  429. <link linkend='var-PV'><filename>PV</filename></link>
  430. contains
  431. <filename>${</filename><link linkend='var-SRCPV'><filename>SRCPV</filename></link><filename>}</filename>.
  432. For example, suppose you have a kernel recipe that
  433. inherits the
  434. <link linkend='ref-classes-kernel'>kernel</link> class
  435. and you use the previous statement.
  436. In this example, <filename>${SRCPV}</filename> does not
  437. automatically get into <filename>PV</filename>.
  438. Consequently, you need to change <filename>PV</filename>
  439. in your recipe so that it does contain
  440. <filename>${SRCPV}</filename>.
  441. </para>
  442. </glossdef>
  443. </glossentry>
  444. <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm>
  445. <info>
  446. AVAILTUNES[doc] = "The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system."
  447. </info>
  448. <glossdef>
  449. <para role="glossdeffirst">
  450. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  451. The list of defined CPU and Application Binary Interface
  452. (ABI) tunings (i.e. "tunes") available for use by the
  453. OpenEmbedded build system.
  454. </para>
  455. <para>
  456. The list simply presents the tunes that are available.
  457. Not all tunes may be compatible with a particular
  458. machine configuration, or with each other in a
  459. <ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Multilib</ulink>
  460. configuration.
  461. </para>
  462. <para>
  463. To add a tune to the list, be sure to append it with
  464. spaces using the "+=" BitBake operator.
  465. Do not simply replace the list by using the "=" operator.
  466. See the
  467. "<ulink url='&YOCTO_DOCS_BB_URL;#basic-syntax'>Basic Syntax</ulink>"
  468. section in the BitBake User Manual for more information.
  469. </para>
  470. </glossdef>
  471. </glossentry>
  472. </glossdiv>
  473. <glossdiv id='var-glossary-b'><title>B</title>
  474. <glossentry id='var-B'><glossterm>B</glossterm>
  475. <info>
  476. B[doc] = "The Build Directory. The OpenEmbedded build system places generated objects into the Build Directory during a recipe's build process."
  477. </info>
  478. <glossdef>
  479. <para role="glossdeffirst">
  480. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  481. The directory within the
  482. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
  483. in which the OpenEmbedded build system places generated
  484. objects during a recipe's build process.
  485. By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
  486. directory, which is defined as:
  487. <literallayout class='monospaced'>
  488. S = "${WORKDIR}/${BP}/"
  489. </literallayout>
  490. </para>
  491. <para>
  492. You can separate the (<filename>S</filename>) directory
  493. and the directory pointed to by the <filename>B</filename>
  494. variable.
  495. Most Autotools-based recipes support separating these
  496. directories.
  497. The build system defaults to using separate directories for
  498. <filename>gcc</filename> and some kernel recipes.
  499. </para>
  500. </glossdef>
  501. </glossentry>
  502. <glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm>
  503. <info>
  504. BAD_RECOMMENDATIONS[doc] = "A list of packages not to install despite being recommended by a recipe. Support for this variable exists only when using the IPK packaging backend."
  505. </info>
  506. <glossdef>
  507. <para role="glossdeffirst">
  508. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  509. Lists "recommended-only" packages to not install.
  510. Recommended-only packages are packages installed only
  511. through the
  512. <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
  513. variable.
  514. You can prevent any of these "recommended" packages from
  515. being installed by listing them with the
  516. <filename>BAD_RECOMMENDATIONS</filename> variable:
  517. <literallayout class='monospaced'>
  518. BAD_RECOMMENDATIONS = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..."
  519. </literallayout>
  520. </para>
  521. <para>
  522. You can set this variable globally in your
  523. <filename>local.conf</filename> file or you can attach it to
  524. a specific image recipe by using the recipe name override:
  525. <literallayout class='monospaced'>
  526. BAD_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>"
  527. </literallayout>
  528. </para>
  529. <para>
  530. It is important to realize that if you choose to not install
  531. packages using this variable and some other packages are
  532. dependent on them (i.e. listed in a recipe's
  533. <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
  534. variable), the OpenEmbedded build system ignores your
  535. request and will install the packages to avoid dependency
  536. errors.
  537. </para>
  538. <para>
  539. Support for this variable exists only when using the
  540. IPK and RPM packaging backend.
  541. Support does not exist for DEB.
  542. </para>
  543. <para>
  544. See the
  545. <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>
  546. and the
  547. <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
  548. variables for related information.
  549. </para>
  550. </glossdef>
  551. </glossentry>
  552. <glossentry id='var-BASE_LIB'><glossterm>BASE_LIB</glossterm>
  553. <info>
  554. BASE_LIB[doc] = "The library directory name for the CPU or Application Binary Interface (ABI) tune."
  555. </info>
  556. <glossdef>
  557. <para role="glossdeffirst">
  558. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  559. The library directory name for the CPU or Application
  560. Binary Interface (ABI) tune.
  561. The <filename>BASE_LIB</filename> applies only in the
  562. Multilib context.
  563. See the
  564. "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>"
  565. section in the Yocto Project Development Manual for
  566. information on Multilib.
  567. </para>
  568. <para>
  569. The <filename>BASE_LIB</filename> variable is defined in
  570. the machine include files in the
  571. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  572. If Multilib is not being used, the value defaults to "lib".
  573. </para>
  574. </glossdef>
  575. </glossentry>
  576. <glossentry id='var-BASE_WORKDIR'><glossterm>BASE_WORKDIR</glossterm>
  577. <info>
  578. BASE_WORKDIR[doc] = "Points to the base of the work directory for all recipes."
  579. </info>
  580. <glossdef>
  581. <para role="glossdeffirst">
  582. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  583. Points to the base of the work directory for all recipes.
  584. The default value is "${TMPDIR}/work".
  585. </para>
  586. </glossdef>
  587. </glossentry>
  588. <glossentry id='var-BB_ALLOWED_NETWORKS'><glossterm>BB_ALLOWED_NETWORKS</glossterm>
  589. <info>
  590. BB_ALLOWED_NETWORKS[doc] = "A list of hosts that the fetcher is allowed to use to obtain the required source code."
  591. </info>
  592. <glossdef>
  593. <para>
  594. Specifies a space-delimited list of hosts that the fetcher
  595. is allowed to use to obtain the required source code.
  596. Following are considerations surrounding this variable:
  597. <itemizedlist>
  598. <listitem><para>
  599. This host list is only used if
  600. <filename>BB_NO_NETWORK</filename> is either not
  601. set or set to "0".
  602. </para></listitem>
  603. <listitem><para>
  604. Limited support for wildcard matching against the
  605. beginning of host names exists.
  606. For example, the following setting matches
  607. <filename>git.gnu.org</filename>,
  608. <filename>ftp.gnu.org</filename>, and
  609. <filename>foo.git.gnu.org</filename>.
  610. <literallayout class='monospaced'>
  611. BB_ALLOWED_NETWORKS = "*.gnu.org"
  612. </literallayout>
  613. </para></listitem>
  614. <listitem><para>
  615. Mirrors not in the host list are skipped and
  616. logged in debug.
  617. </para></listitem>
  618. <listitem><para>
  619. Attempts to access networks not in the host list
  620. cause a failure.
  621. </para></listitem>
  622. </itemizedlist>
  623. Using <filename>BB_ALLOWED_NETWORKS</filename> in
  624. conjunction with
  625. <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
  626. is very useful.
  627. Adding the host you want to use to
  628. <filename>PREMIRRORS</filename> results in the source code
  629. being fetched from an allowed location and avoids raising
  630. an error when a host that is not allowed is in a
  631. <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
  632. statement.
  633. This is because the fetcher does not attempt to use the
  634. host listed in <filename>SRC_URI</filename> after a
  635. successful fetch from the
  636. <filename>PREMIRRORS</filename> occurs.
  637. </para>
  638. </glossdef>
  639. </glossentry>
  640. <glossentry id='var-BB_DANGLINGAPPENDS_WARNONLY'><glossterm>BB_DANGLINGAPPENDS_WARNONLY</glossterm>
  641. <info>
  642. BB_DANGLINGAPPENDS_WARNONLY[doc] = "Defines how BitBake handles situations where an append file (.bbappend) has no corresponding recipe file (.bb)."
  643. </info>
  644. <glossdef>
  645. <para role="glossdeffirst">
  646. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  647. Defines how BitBake handles situations where an append
  648. file (<filename>.bbappend</filename>) has no
  649. corresponding recipe file (<filename>.bb</filename>).
  650. This condition often occurs when layers get out of sync
  651. (e.g. <filename>oe-core</filename> bumps a
  652. recipe version and the old recipe no longer exists and the
  653. other layer has not been updated to the new version
  654. of the recipe yet).
  655. </para>
  656. <para>
  657. The default fatal behavior is safest because it is
  658. the sane reaction given something is out of sync.
  659. It is important to realize when your changes are no longer
  660. being applied.
  661. </para>
  662. <para>
  663. You can change the default behavior by setting this
  664. variable to "1", "yes", or "true"
  665. in your <filename>local.conf</filename> file, which is
  666. located in the
  667. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
  668. Here is an example:
  669. <literallayout class='monospaced'>
  670. BB_DANGLINGAPPENDS_WARNONLY = "1"
  671. </literallayout>
  672. </para>
  673. </glossdef>
  674. </glossentry>
  675. <glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm>
  676. <info>
  677. BB_DISKMON_DIRS[doc] = "Monitors disk space and available inodes during the build and allows you to control the build based on these parameters."
  678. </info>
  679. <glossdef>
  680. <para role="glossdeffirst">
  681. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  682. Monitors disk space and available inodes during the build
  683. and allows you to control the build based on these
  684. parameters.
  685. </para>
  686. <para>
  687. Disk space monitoring is disabled by default.
  688. To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename>
  689. variable to your <filename>conf/local.conf</filename> file found in the
  690. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  691. Use the following form:
  692. <literallayout class='monospaced'>
  693. BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]"
  694. where:
  695. <replaceable>action</replaceable> is:
  696. ABORT: Immediately abort the build when
  697. a threshold is broken.
  698. STOPTASKS: Stop the build after the currently
  699. executing tasks have finished when
  700. a threshold is broken.
  701. WARN: Issue a warning but continue the
  702. build when a threshold is broken.
  703. Subsequent warnings are issued as
  704. defined by the
  705. <link linkend='var-BB_DISKMON_WARNINTERVAL'>BB_DISKMON_WARNINTERVAL</link> variable,
  706. which must be defined in the
  707. conf/local.conf file.
  708. <replaceable>dir</replaceable> is:
  709. Any directory you choose. You can specify one or
  710. more directories to monitor by separating the
  711. groupings with a space. If two directories are
  712. on the same device, only the first directory
  713. is monitored.
  714. <replaceable>threshold</replaceable> is:
  715. Either the minimum available disk space,
  716. the minimum number of free inodes, or
  717. both. You must specify at least one. To
  718. omit one or the other, simply omit the value.
  719. Specify the threshold using G, M, K for Gbytes,
  720. Mbytes, and Kbytes, respectively. If you do
  721. not specify G, M, or K, Kbytes is assumed by
  722. default. Do not use GB, MB, or KB.
  723. </literallayout>
  724. </para>
  725. <para>
  726. Here are some examples:
  727. <literallayout class='monospaced'>
  728. BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K"
  729. BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G"
  730. BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
  731. </literallayout>
  732. The first example works only if you also provide
  733. the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable
  734. in the <filename>conf/local.conf</filename>.
  735. This example causes the build system to immediately
  736. abort when either the disk space in <filename>${TMPDIR}</filename> drops
  737. below 1 Gbyte or the available free inodes drops below
  738. 100 Kbytes.
  739. Because two directories are provided with the variable, the
  740. build system also issue a
  741. warning when the disk space in the
  742. <filename>${SSTATE_DIR}</filename> directory drops
  743. below 1 Gbyte or the number of free inodes drops
  744. below 100 Kbytes.
  745. Subsequent warnings are issued during intervals as
  746. defined by the <filename>BB_DISKMON_WARNINTERVAL</filename>
  747. variable.
  748. </para>
  749. <para>
  750. The second example stops the build after all currently
  751. executing tasks complete when the minimum disk space
  752. in the <filename>${<link linkend='var-TMPDIR'>TMPDIR</link>}</filename>
  753. directory drops below 1 Gbyte.
  754. No disk monitoring occurs for the free inodes in this case.
  755. </para>
  756. <para>
  757. The final example immediately aborts the build when the
  758. number of free inodes in the <filename>${TMPDIR}</filename> directory
  759. drops below 100 Kbytes.
  760. No disk space monitoring for the directory itself occurs
  761. in this case.
  762. </para>
  763. </glossdef>
  764. </glossentry>
  765. <glossentry id='var-BB_DISKMON_WARNINTERVAL'><glossterm>BB_DISKMON_WARNINTERVAL</glossterm>
  766. <info>
  767. BB_DISKMON_WARNINTERVAL[doc] = "Defines the disk space and free inode warning intervals. To set these intervals, define the variable in the conf/local.conf file in the Build Directory."
  768. </info>
  769. <glossdef>
  770. <para role="glossdeffirst">
  771. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  772. Defines the disk space and free inode warning intervals.
  773. To set these intervals, define the variable in your
  774. <filename>conf/local.conf</filename> file in the
  775. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  776. </para>
  777. <para>
  778. If you are going to use the
  779. <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must
  780. also use the
  781. <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable
  782. and define its action as "WARN".
  783. During the build, subsequent warnings are issued each time
  784. disk space or number of free inodes further reduces by
  785. the respective interval.
  786. </para>
  787. <para>
  788. If you do not provide a <filename>BB_DISKMON_WARNINTERVAL</filename>
  789. variable and you do use <filename>BB_DISKMON_DIRS</filename> with
  790. the "WARN" action, the disk monitoring interval defaults to
  791. the following:
  792. <literallayout class='monospaced'>
  793. BB_DISKMON_WARNINTERVAL = "50M,5K"
  794. </literallayout>
  795. </para>
  796. <para>
  797. When specifying the variable in your configuration file,
  798. use the following form:
  799. <literallayout class='monospaced'>
  800. BB_DISKMON_WARNINTERVAL = "<replaceable>disk_space_interval</replaceable>,<replaceable>disk_inode_interval</replaceable>"
  801. where:
  802. <replaceable>disk_space_interval</replaceable> is:
  803. An interval of memory expressed in either
  804. G, M, or K for Gbytes, Mbytes, or Kbytes,
  805. respectively. You cannot use GB, MB, or KB.
  806. <replaceable>disk_inode_interval</replaceable> is:
  807. An interval of free inodes expressed in either
  808. G, M, or K for Gbytes, Mbytes, or Kbytes,
  809. respectively. You cannot use GB, MB, or KB.
  810. </literallayout>
  811. </para>
  812. <para>
  813. Here is an example:
  814. <literallayout class='monospaced'>
  815. BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
  816. BB_DISKMON_WARNINTERVAL = "50M,5K"
  817. </literallayout>
  818. These variables cause the OpenEmbedded build system to
  819. issue subsequent warnings each time the available
  820. disk space further reduces by 50 Mbytes or the number
  821. of free inodes further reduces by 5 Kbytes in the
  822. <filename>${SSTATE_DIR}</filename> directory.
  823. Subsequent warnings based on the interval occur each time
  824. a respective interval is reached beyond the initial warning
  825. (i.e. 1 Gbytes and 100 Kbytes).
  826. </para>
  827. </glossdef>
  828. </glossentry>
  829. <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm>
  830. <info>
  831. BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the Git repositories to be placed in the DL_DIR directory."
  832. </info>
  833. <glossdef>
  834. <para role="glossdeffirst">
  835. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  836. Causes tarballs of the Git repositories, including the
  837. Git metadata, to be placed in the
  838. <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
  839. directory.
  840. </para>
  841. <para>
  842. For performance reasons, creating and placing tarballs of
  843. the Git repositories is not the default action by the
  844. OpenEmbedded build system.
  845. <literallayout class='monospaced'>
  846. BB_GENERATE_MIRROR_TARBALLS = "1"
  847. </literallayout>
  848. Set this variable in your <filename>local.conf</filename>
  849. file in the
  850. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  851. </para>
  852. </glossdef>
  853. </glossentry>
  854. <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
  855. <info>
  856. BB_NUMBER_THREADS[doc] = "The maximum number of tasks BitBake should run in parallel at any one time. This variable is automatically configured to be equal to the number of build system cores."
  857. </info>
  858. <glossdef>
  859. <para role="glossdeffirst">
  860. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  861. The maximum number of tasks BitBake should run in parallel
  862. at any one time.
  863. The OpenEmbedded build system automatically configures
  864. this variable to be equal to the number of cores on the
  865. build system.
  866. For example, a system with a dual core processor that
  867. also uses hyper-threading causes the
  868. <filename>BB_NUMBER_THREADS</filename> variable to default
  869. to "4".
  870. </para>
  871. <para>
  872. For single socket systems (i.e. one CPU), you should not
  873. have to override this variable to gain optimal parallelism
  874. during builds.
  875. However, if you have very large systems that employ
  876. multiple physical CPUs, you might want to make sure the
  877. <filename>BB_NUMBER_THREADS</filename> variable is not
  878. set higher than "20".
  879. </para>
  880. <para>
  881. For more information on speeding up builds, see the
  882. "<link linkend='speeding-up-the-build'>Speeding Up the Build</link>"
  883. section.
  884. </para>
  885. </glossdef>
  886. </glossentry>
  887. <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm>
  888. <info>
  889. BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes are 'native', 'cross', 'nativesdk' and multilibs."
  890. </info>
  891. <glossdef>
  892. <para role="glossdeffirst">
  893. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  894. Allows you to extend a recipe so that it builds variants of the software.
  895. Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>,
  896. which is a copy of Quilt built to run on the build system;
  897. "crosses" such as <filename>gcc-cross</filename>,
  898. which is a compiler built to run on the build machine but produces binaries
  899. that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>;
  900. "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>;
  901. and "mulitlibs" in the form "<filename>multilib:</filename><replaceable>multilib_name</replaceable>".
  902. </para>
  903. <para>
  904. To build a different variant of the recipe with a minimal amount of code, it usually
  905. is as simple as adding the following to your recipe:
  906. <literallayout class='monospaced'>
  907. BBCLASSEXTEND =+ "native nativesdk"
  908. BBCLASSEXTEND =+ "multilib:<replaceable>multilib_name</replaceable>"
  909. </literallayout>
  910. </para>
  911. </glossdef>
  912. </glossentry>
  913. <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
  914. <info>
  915. BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are used to find the other BBFILE_* variables."
  916. </info>
  917. <glossdef>
  918. <para role="glossdeffirst">
  919. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  920. Lists the names of configured layers.
  921. These names are used to find the other <filename>BBFILE_*</filename>
  922. variables.
  923. Typically, each layer will append its name to this variable in its
  924. <filename>conf/layer.conf</filename> file.
  925. </para>
  926. </glossdef>
  927. </glossentry>
  928. <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm>
  929. <info>
  930. BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. This variable is used in the layer.conf file and must be suffixed with the name of a layer."
  931. </info>
  932. <glossdef>
  933. <para role="glossdeffirst">
  934. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  935. Variable that expands to match files from
  936. <link linkend='var-BBFILES'><filename>BBFILES</filename></link>
  937. in a particular layer.
  938. This variable is used in the <filename>conf/layer.conf</filename> file and must
  939. be suffixed with the name of the specific layer (e.g.
  940. <filename>BBFILE_PATTERN_emenlow</filename>).
  941. </para>
  942. </glossdef>
  943. </glossentry>
  944. <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
  945. <info>
  946. BBFILE_PRIORITY[doc] = "Assigns the priority for recipe files in each layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe."
  947. </info>
  948. <glossdef>
  949. <para role="glossdeffirst">
  950. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  951. Assigns the priority for recipe files in each layer.
  952. </para>
  953. <para>
  954. This variable is useful in situations where the same recipe appears in
  955. more than one layer.
  956. Setting this variable allows you to prioritize a
  957. layer against other layers that contain the same recipe - effectively
  958. letting you control the precedence for the multiple layers.
  959. The precedence established through this variable stands regardless of a
  960. recipe's version
  961. (<link linkend='var-PV'><filename>PV</filename></link> variable).
  962. For example, a layer that has a recipe with a higher <filename>PV</filename> value but for
  963. which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a
  964. lower precedence.
  965. </para>
  966. <para>
  967. A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher
  968. precedence.
  969. For example, the value 6 has a higher precedence than the value 5.
  970. If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer
  971. dependencies (see the
  972. <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for
  973. more information.
  974. The default priority, if unspecified
  975. for a layer with no dependencies, is the lowest defined priority + 1
  976. (or 1 if no priorities are defined).
  977. </para>
  978. <tip>
  979. You can use the command <filename>bitbake-layers show-layers</filename> to list
  980. all configured layers along with their priorities.
  981. </tip>
  982. </glossdef>
  983. </glossentry>
  984. <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
  985. <info>
  986. BBFILES[doc] = "List of recipe files used by BitBake to build software."
  987. </info>
  988. <glossdef>
  989. <para role="glossdeffirst">
  990. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  991. List of recipe files used by BitBake to build software.
  992. </para>
  993. </glossdef>
  994. </glossentry>
  995. <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
  996. <info>
  997. BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure."
  998. </info>
  999. <glossdef>
  1000. <para role="glossdeffirst">
  1001. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1002. Variable that controls how BitBake displays logs on build failure.
  1003. </para>
  1004. </glossdef>
  1005. </glossentry>
  1006. <glossentry id='var-BBINCLUDELOGS_LINES'><glossterm>BBINCLUDELOGS_LINES</glossterm>
  1007. <info>
  1008. BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure."
  1009. </info>
  1010. <glossdef>
  1011. <para role="glossdeffirst">
  1012. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1013. If
  1014. <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link>
  1015. is set, specifies the maximum number of lines from the
  1016. task log file to print when reporting a failed task.
  1017. If you do not set <filename>BBINCLUDELOGS_LINES</filename>,
  1018. the entire log is printed.
  1019. </para>
  1020. </glossdef>
  1021. </glossentry>
  1022. <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm>
  1023. <info>
  1024. BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file."
  1025. </info>
  1026. <glossdef>
  1027. <para role="glossdeffirst">
  1028. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1029. Lists the layers to enable during the build.
  1030. This variable is defined in the <filename>bblayers.conf</filename> configuration
  1031. file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  1032. Here is an example:
  1033. <literallayout class='monospaced'>
  1034. BBLAYERS = " \
  1035. /home/scottrif/poky/meta \
  1036. /home/scottrif/poky/meta-poky \
  1037. /home/scottrif/poky/meta-yocto-bsp \
  1038. /home/scottrif/poky/meta-mykernel \
  1039. "
  1040. </literallayout>
  1041. </para>
  1042. <para>
  1043. This example enables four layers, one of which is a custom, user-defined layer
  1044. named <filename>meta-mykernel</filename>.
  1045. </para>
  1046. </glossdef>
  1047. </glossentry>
  1048. <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm>
  1049. <info>
  1050. BBMASK[doc] = "Prevents BitBake from processing specific recipes or recipe append files."
  1051. </info>
  1052. <glossdef>
  1053. <para role="glossdeffirst">
  1054. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1055. Prevents BitBake from processing recipes and recipe
  1056. append files.
  1057. </para>
  1058. <para>
  1059. You can use the <filename>BBMASK</filename> variable
  1060. to "hide" these <filename>.bb</filename> and
  1061. <filename>.bbappend</filename> files.
  1062. BitBake ignores any recipe or recipe append files that
  1063. match any of the expressions.
  1064. It is as if BitBake does not see them at all.
  1065. Consequently, matching files are not parsed or otherwise
  1066. used by BitBake.</para>
  1067. <para>
  1068. The values you provide are passed to Python's regular
  1069. expression compiler.
  1070. The expressions are compared against the full paths to
  1071. the files.
  1072. For complete syntax information, see Python's
  1073. documentation at
  1074. <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
  1075. </para>
  1076. <para>
  1077. The following example uses a complete regular expression
  1078. to tell BitBake to ignore all recipe and recipe append
  1079. files in the <filename>meta-ti/recipes-misc/</filename>
  1080. directory:
  1081. <literallayout class='monospaced'>
  1082. BBMASK = "meta-ti/recipes-misc/"
  1083. </literallayout>
  1084. If you want to mask out multiple directories or recipes,
  1085. you can specify multiple regular expression fragments.
  1086. This next example masks out multiple directories and
  1087. individual recipes:
  1088. <literallayout class='monospaced'>
  1089. BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/"
  1090. BBMASK += "/meta-oe/recipes-support/"
  1091. BBMASK += "/meta-foo/.*/openldap"
  1092. BBMASK += "opencv.*\.bbappend"
  1093. BBMASK += "lzma"
  1094. </literallayout>
  1095. <note>
  1096. When specifying a directory name, use the trailing
  1097. slash character to ensure you match just that directory
  1098. name.
  1099. </note>
  1100. </para>
  1101. </glossdef>
  1102. </glossentry>
  1103. <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
  1104. <info>
  1105. BBPATH[doc] = "Used by BitBake to locate .bbclass and configuration files. This variable is analogous to the PATH variable."
  1106. </info>
  1107. <glossdef>
  1108. <para role="glossdeffirst">
  1109. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1110. Used by BitBake to locate
  1111. <filename>.bbclass</filename> and configuration files.
  1112. This variable is analogous to the
  1113. <filename>PATH</filename> variable.
  1114. <note>
  1115. If you run BitBake from a directory outside of the
  1116. <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>,
  1117. you must be sure to set
  1118. <filename>BBPATH</filename> to point to the
  1119. Build Directory.
  1120. Set the variable as you would any environment variable
  1121. and then run BitBake:
  1122. <literallayout class='monospaced'>
  1123. $ BBPATH = "<replaceable>build_directory</replaceable>"
  1124. $ export BBPATH
  1125. $ bitbake <replaceable>target</replaceable>
  1126. </literallayout>
  1127. </note>
  1128. </para>
  1129. </glossdef>
  1130. </glossentry>
  1131. <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm>
  1132. <info>
  1133. BBSERVER[doc] = "Points to the server that runs memory-resident BitBake."
  1134. </info>
  1135. <glossdef>
  1136. <para role="glossdeffirst">
  1137. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1138. Points to the server that runs memory-resident BitBake.
  1139. This variable is set by the
  1140. <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
  1141. setup script and should not be hand-edited.
  1142. The variable is only used when you employ memory-resident
  1143. BitBake.
  1144. The setup script exports the value as follows:
  1145. <literallayout class='monospaced'>
  1146. export BBSERVER=localhost:$port
  1147. </literallayout>
  1148. </para>
  1149. <para>
  1150. For more information on how the
  1151. <filename>BBSERVER</filename> is used, see the
  1152. <filename>oe-init-build-env-memres</filename> script, which
  1153. is located in the
  1154. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  1155. </para>
  1156. </glossdef>
  1157. </glossentry>
  1158. <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm>
  1159. <info>
  1160. BINCONFIG[doc] = "When inheriting the binconfig-disabled class, this variable specifies binary configuration scripts to disable in favor of using pkg-config to query the information."
  1161. </info>
  1162. <glossdef>
  1163. <para role="glossdeffirst">
  1164. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1165. When inheriting the
  1166. <link linkend='ref-classes-binconfig-disabled'><filename>binconfig-disabled</filename></link>
  1167. class, this variable specifies binary configuration
  1168. scripts to disable in favor of using
  1169. <filename>pkg-config</filename> to query the information.
  1170. The <filename>binconfig-disabled</filename> class will
  1171. modify the specified scripts to return an error so that
  1172. calls to them can be easily found and replaced.
  1173. </para>
  1174. <para>
  1175. To add multiple scripts, separate them by spaces.
  1176. Here is an example from the <filename>libpng</filename>
  1177. recipe:
  1178. <literallayout class='monospaced'>
  1179. BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config"
  1180. </literallayout>
  1181. </para>
  1182. </glossdef>
  1183. </glossentry>
  1184. <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
  1185. <info>
  1186. BINCONFIG_GLOB[doc] = "When inheriting binconfig.bbclass from a recipe, this variable specifies a wildcard for configuration scripts that need editing."
  1187. </info>
  1188. <glossdef>
  1189. <para role="glossdeffirst">
  1190. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1191. When inheriting the
  1192. <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
  1193. class, this variable specifies a wildcard for
  1194. configuration scripts that need editing.
  1195. The scripts are edited to correct any paths that have been
  1196. set up during compilation so that they are correct for
  1197. use when installed into the sysroot and called by the
  1198. build processes of other recipes.
  1199. </para>
  1200. <para>
  1201. For more information on how this variable works, see
  1202. <filename>meta/classes/binconfig.bbclass</filename> in the
  1203. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  1204. You can also find general information on the class in the
  1205. "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>"
  1206. section.
  1207. </para>
  1208. </glossdef>
  1209. </glossentry>
  1210. <glossentry id='var-BP'><glossterm>BP</glossterm>
  1211. <info>
  1212. BP[doc] = "The base recipe name and version but without any special recipe name suffix (i.e. -native, lib64-, and so forth). BP is comprised of ${BPN}-${PV}"
  1213. </info>
  1214. <glossdef>
  1215. <para role="glossdeffirst">
  1216. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1217. The base recipe name and version but without any special
  1218. recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>,
  1219. and so forth).
  1220. <filename>BP</filename> is comprised of the following:
  1221. <literallayout class="monospaced">
  1222. ${BPN}-${PV}
  1223. </literallayout>
  1224. </para>
  1225. </glossdef>
  1226. </glossentry>
  1227. <glossentry id='var-BPN'><glossterm>BPN</glossterm>
  1228. <info>
  1229. BPN[doc] = "The bare name of the recipe. This variable is a version of the PN variable but removes common suffixes and prefixes."
  1230. </info>
  1231. <glossdef>
  1232. <para role="glossdeffirst">
  1233. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1234. The bare name of the recipe.
  1235. This variable is a version of the
  1236. <link linkend='var-PN'><filename>PN</filename></link>
  1237. variable but removes common suffixes such as
  1238. <filename>-native</filename> and
  1239. <filename>-cross</filename> as well
  1240. as removes common prefixes such as multilib's
  1241. <filename>lib64-</filename> and
  1242. <filename>lib32-</filename>.
  1243. The exact list of suffixes removed is specified by the
  1244. <link linkend='var-SPECIAL_PKGSUFFIX'><filename>SPECIAL_PKGSUFFIX</filename></link>
  1245. variable.
  1246. The exact list of prefixes removed is specified by the
  1247. <link linkend='var-MLPREFIX'><filename>MLPREFIX</filename></link>
  1248. variable.
  1249. Prefixes are removed for <filename>multilib</filename>
  1250. and <filename>nativesdk-</filename> cases.
  1251. </para>
  1252. </glossdef>
  1253. </glossentry>
  1254. <glossentry id='var-BUGTRACKER'><glossterm>BUGTRACKER</glossterm>
  1255. <info>
  1256. BUGTRACKER[doc] = "Specifies a URL for an upstream bug tracking website for a recipe."
  1257. </info>
  1258. <glossdef>
  1259. <para role="glossdeffirst">
  1260. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1261. Specifies a URL for an upstream bug tracking website for
  1262. a recipe.
  1263. The OpenEmbedded build system does not use this variable.
  1264. Rather, the variable is a useful pointer in case a bug
  1265. in the software being built needs to be manually reported.
  1266. </para>
  1267. </glossdef>
  1268. </glossentry>
  1269. <glossentry id='var-BUILD_ARCH'><glossterm>BUILD_ARCH</glossterm>
  1270. <info>
  1271. BUILD_ARCH[doc] = "The name of the building architecture (e.g. i686)."
  1272. </info>
  1273. <glossdef>
  1274. <para role="glossdeffirst">
  1275. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1276. Specifies the architecture of the build host
  1277. (e.g. <filename>i686</filename>).
  1278. The OpenEmbedded build system sets the value of
  1279. <filename>BUILD_ARCH</filename> from the machine name
  1280. reported by the <filename>uname</filename> command.
  1281. </para>
  1282. </glossdef>
  1283. </glossentry>
  1284. <glossentry id='var-BUILD_CFLAGS'><glossterm>BUILD_CFLAGS</glossterm>
  1285. <info>
  1286. BUILD_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the build host."
  1287. </info>
  1288. <glossdef>
  1289. <para role="glossdeffirst">
  1290. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1291. Specifies the flags to pass to the C compiler when building
  1292. for the build host.
  1293. When building in the <filename>-native</filename> context,
  1294. <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
  1295. is set to the value of this variable by default.
  1296. </para>
  1297. </glossdef>
  1298. </glossentry>
  1299. <glossentry id='var-BUILD_CPPFLAGS'><glossterm>BUILD_CPPFLAGS</glossterm>
  1300. <info>
  1301. BUILD_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the build host."
  1302. </info>
  1303. <glossdef>
  1304. <para role="glossdeffirst">
  1305. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1306. Specifies the flags to pass to the C pre-processor
  1307. (i.e. to both the C and the C++ compilers) when building
  1308. for the build host.
  1309. When building in the <filename>-native</filename> context,
  1310. <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link>
  1311. is set to the value of this variable by default.
  1312. </para>
  1313. </glossdef>
  1314. </glossentry>
  1315. <glossentry id='var-BUILD_CXXFLAGS'><glossterm>BUILD_CXXFLAGS</glossterm>
  1316. <info>
  1317. BUILD_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the build host."
  1318. </info>
  1319. <glossdef>
  1320. <para role="glossdeffirst">
  1321. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1322. Specifies the flags to pass to the C++ compiler when
  1323. building for the build host.
  1324. When building in the <filename>-native</filename> context,
  1325. <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link>
  1326. is set to the value of this variable by default.
  1327. </para>
  1328. </glossdef>
  1329. </glossentry>
  1330. <glossentry id='var-BUILD_LDFLAGS'><glossterm>BUILD_LDFLAGS</glossterm>
  1331. <info>
  1332. BUILD_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the build host."
  1333. </info>
  1334. <glossdef>
  1335. <para role="glossdeffirst">
  1336. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1337. Specifies the flags to pass to the linker when building
  1338. for the build host.
  1339. When building in the <filename>-native</filename> context,
  1340. <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>
  1341. is set to the value of this variable by default.
  1342. </para>
  1343. </glossdef>
  1344. </glossentry>
  1345. <glossentry id='var-BUILD_OPTIMIZATION'><glossterm>BUILD_OPTIMIZATION</glossterm>
  1346. <info>
  1347. BUILD_OPTIMIZATION[doc] = "Specifies the optimization flags passed to the C compiler when building for the build host or the SDK."
  1348. </info>
  1349. <glossdef>
  1350. <para role="glossdeffirst">
  1351. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1352. Specifies the optimization flags passed to the C compiler
  1353. when building for the build host or the SDK.
  1354. The flags are passed through the
  1355. <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link>
  1356. and
  1357. <link linkend='var-BUILDSDK_CFLAGS'><filename>BUILDSDK_CFLAGS</filename></link>
  1358. default values.
  1359. </para>
  1360. <para>
  1361. The default value of the
  1362. <filename>BUILD_OPTIMIZATION</filename> variable is
  1363. "-O2 -pipe".
  1364. </para>
  1365. </glossdef>
  1366. </glossentry>
  1367. <glossentry id='var-BUILD_OS'><glossterm>BUILD_OS</glossterm>
  1368. <info>
  1369. BUILD_OS[doc] = "The operating system (in lower case) of the building architecture (e.g. Linux)."
  1370. </info>
  1371. <glossdef>
  1372. <para role="glossdeffirst">
  1373. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1374. Specifies the operating system in use on the build
  1375. host (e.g. "linux").
  1376. The OpenEmbedded build system sets the value of
  1377. <filename>BUILD_OS</filename> from the OS reported by
  1378. the <filename>uname</filename> command - the first word,
  1379. converted to lower-case characters.
  1380. </para>
  1381. </glossdef>
  1382. </glossentry>
  1383. <glossentry id='var-BUILD_PREFIX'><glossterm>BUILD_PREFIX</glossterm>
  1384. <info>
  1385. BUILD_PREFIX[doc] = "The toolchain binary prefix used for native recipes."
  1386. </info>
  1387. <glossdef>
  1388. <para role="glossdeffirst">
  1389. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1390. The toolchain binary prefix used for native recipes.
  1391. The OpenEmbedded build system uses the
  1392. <filename>BUILD_PREFIX</filename> value to set the
  1393. <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>
  1394. when building for <filename>native</filename> recipes.
  1395. </para>
  1396. </glossdef>
  1397. </glossentry>
  1398. <glossentry id='var-BUILD_SYS'><glossterm>BUILD_SYS</glossterm>
  1399. <info>
  1400. BUILD_SYS[doc] = "The toolchain binary prefix used for native recipes."
  1401. </info>
  1402. <glossdef>
  1403. <para role="glossdeffirst">
  1404. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1405. Specifies the system, including the architecture and
  1406. the operating system, to use when building for the build
  1407. host (i.e. when building <filename>native</filename>
  1408. recipes).
  1409. </para>
  1410. <para>
  1411. The OpenEmbedded build system automatically sets this
  1412. variable based on
  1413. <link linkend='var-BUILD_ARCH'><filename>BUILD_ARCH</filename></link>,
  1414. <link linkend='var-BUILD_VENDOR'><filename>BUILD_VENDOR</filename></link>,
  1415. and
  1416. <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>.
  1417. You do not need to set the <filename>BUILD_SYS</filename>
  1418. variable yourself.
  1419. </para>
  1420. </glossdef>
  1421. </glossentry>
  1422. <glossentry id='var-BUILD_VENDOR'><glossterm>BUILD_VENDOR</glossterm>
  1423. <info>
  1424. BUILD_VENDOR[doc] = "The vendor name to use when building for the build host."
  1425. </info>
  1426. <glossdef>
  1427. <para role="glossdeffirst">
  1428. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1429. Specifies the vendor name to use when building for the
  1430. build host.
  1431. The default value is an empty string ("").
  1432. </para>
  1433. </glossdef>
  1434. </glossentry>
  1435. <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm>
  1436. <info>
  1437. BUILDDIR[doc] = "Points to the location of the Build Directory."
  1438. </info>
  1439. <glossdef>
  1440. <para role="glossdeffirst">
  1441. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1442. Points to the location of the
  1443. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  1444. You can define this directory indirectly through the
  1445. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
  1446. and
  1447. <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
  1448. scripts by passing in a Build Directory path when you run
  1449. the scripts.
  1450. If you run the scripts and do not provide a Build Directory
  1451. path, the <filename>BUILDDIR</filename> defaults to
  1452. <filename>build</filename> in the current directory.
  1453. </para>
  1454. </glossdef>
  1455. </glossentry>
  1456. <glossentry id='var-BUILDHISTORY_COMMIT'><glossterm>BUILDHISTORY_COMMIT</glossterm>
  1457. <info>
  1458. BUILDHISTORY_COMMIT[doc] = "When inheriting the buildhistory class, this variable specifies whether or not to commit the build history output in a local Git repository."
  1459. </info>
  1460. <glossdef>
  1461. <para role="glossdeffirst">
  1462. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1463. When inheriting the
  1464. <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
  1465. class, this variable specifies whether or not to commit the
  1466. build history output in a local Git repository.
  1467. If set to "1", this local repository will be maintained
  1468. automatically by the
  1469. <filename>buildhistory</filename>
  1470. class and a commit will be created on every
  1471. build for changes to each top-level subdirectory of the
  1472. build history output (images, packages, and sdk).
  1473. If you want to track changes to build history over
  1474. time, you should set this value to "1".
  1475. </para>
  1476. <para>
  1477. By default, the <filename>buildhistory</filename> class
  1478. does not commit the build history output in a local
  1479. Git repository:
  1480. <literallayout class='monospaced'>
  1481. BUILDHISTORY_COMMIT ?= "0"
  1482. </literallayout>
  1483. </para>
  1484. </glossdef>
  1485. </glossentry>
  1486. <glossentry id='var-BUILDHISTORY_COMMIT_AUTHOR'><glossterm>BUILDHISTORY_COMMIT_AUTHOR</glossterm>
  1487. <info>
  1488. BUILDHISTORY_COMMIT_AUTHOR[doc] = "When inheriting the buildhistory class, this variable specifies the author to use for each Git commit."
  1489. </info>
  1490. <glossdef>
  1491. <para role="glossdeffirst">
  1492. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1493. When inheriting the
  1494. <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
  1495. class, this variable specifies the author to use for each
  1496. Git commit.
  1497. In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename>
  1498. variable to work, the
  1499. <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
  1500. variable must be set to "1".
  1501. </para>
  1502. <para>
  1503. Git requires that the value you provide for the
  1504. <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable
  1505. takes the form of "name &lt;email@host&gt;".
  1506. Providing an email address or host that is not valid does
  1507. not produce an error.
  1508. </para>
  1509. <para>
  1510. By default, the <filename>buildhistory</filename> class
  1511. sets the variable as follows:
  1512. <literallayout class='monospaced'>
  1513. BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory &lt;buildhistory@${DISTRO}&gt;"
  1514. </literallayout>
  1515. </para>
  1516. </glossdef>
  1517. </glossentry>
  1518. <glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm>
  1519. <info>
  1520. BUILDHISTORY_DIR[doc] = "When inheriting the buildhistory class, this variable specifies the directory in which build history information is kept."
  1521. </info>
  1522. <glossdef>
  1523. <para role="glossdeffirst">
  1524. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1525. When inheriting the
  1526. <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
  1527. class, this variable specifies the directory in which
  1528. build history information is kept.
  1529. For more information on how the variable works, see the
  1530. <filename>buildhistory.class</filename>.
  1531. </para>
  1532. <para>
  1533. By default, the <filename>buildhistory</filename> class
  1534. sets the directory as follows:
  1535. <literallayout class='monospaced'>
  1536. BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
  1537. </literallayout>
  1538. </para>
  1539. </glossdef>
  1540. </glossentry>
  1541. <glossentry id='var-BUILDHISTORY_FEATURES'><glossterm>BUILDHISTORY_FEATURES</glossterm>
  1542. <info>
  1543. BUILDHISTORY_FEATURES[doc] = "When inheriting the buildhistory class, this variable specifies the build history features to be enabled."
  1544. </info>
  1545. <glossdef>
  1546. <para role="glossdeffirst">
  1547. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1548. When inheriting the
  1549. <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
  1550. class, this variable specifies the build history features
  1551. to be enabled.
  1552. For more information on how build history works, see the
  1553. "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
  1554. section.
  1555. </para>
  1556. <para>
  1557. You can specify three features in the form of a
  1558. space-separated list:
  1559. <itemizedlist>
  1560. <listitem><para><emphasis>image:</emphasis>
  1561. Analysis of the contents of images, which
  1562. includes the list of installed packages among other
  1563. things.
  1564. </para></listitem>
  1565. <listitem><para><emphasis>package:</emphasis>
  1566. Analysis of the contents of individual packages.
  1567. </para></listitem>
  1568. <listitem><para><emphasis>sdk:</emphasis>
  1569. Analysis of the contents of the software
  1570. development kit (SDK).
  1571. </para></listitem>
  1572. </itemizedlist>
  1573. </para>
  1574. <para>
  1575. By default, the <filename>buildhistory</filename> class
  1576. enables all three features:
  1577. <literallayout class='monospaced'>
  1578. BUILDHISTORY_FEATURES ?= "image package sdk"
  1579. </literallayout>
  1580. </para>
  1581. </glossdef>
  1582. </glossentry>
  1583. <glossentry id='var-BUILDHISTORY_IMAGE_FILES'><glossterm>BUILDHISTORY_IMAGE_FILES</glossterm>
  1584. <info>
  1585. BUILDHISTORY_IMAGE_FILES[doc] = "When inheriting the buildhistory class, this variable specifies a list of paths to files copied from the image contents into the build history directory under an "image-files" directory in the directory for the image, so that you can track the contents of each file."
  1586. </info>
  1587. <glossdef>
  1588. <para role="glossdeffirst">
  1589. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1590. When inheriting the
  1591. <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
  1592. class, this variable specifies a list of paths to files
  1593. copied from the
  1594. image contents into the build history directory under
  1595. an "image-files" directory in the directory for
  1596. the image, so that you can track the contents of each file.
  1597. The default is to copy <filename>/etc/passwd</filename>
  1598. and <filename>/etc/group</filename>, which allows you to
  1599. monitor for changes in user and group entries.
  1600. You can modify the list to include any file.
  1601. Specifying an invalid path does not produce an error.
  1602. Consequently, you can include files that might
  1603. not always be present.
  1604. </para>
  1605. <para>
  1606. By default, the <filename>buildhistory</filename> class
  1607. provides paths to the following files:
  1608. <literallayout class='monospaced'>
  1609. BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
  1610. </literallayout>
  1611. </para>
  1612. </glossdef>
  1613. </glossentry>
  1614. <glossentry id='var-BUILDHISTORY_PUSH_REPO'><glossterm>BUILDHISTORY_PUSH_REPO</glossterm>
  1615. <info>
  1616. BUILDHISTORY_PUSH_REPO[doc] = "When inheriting the buildhistory class, this variable optionally specifies a remote repository to which build history pushes Git changes."
  1617. </info>
  1618. <glossdef>
  1619. <para role="glossdeffirst">
  1620. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1621. When inheriting the
  1622. <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
  1623. class, this variable optionally specifies a remote
  1624. repository to which build history pushes Git changes.
  1625. In order for <filename>BUILDHISTORY_PUSH_REPO</filename>
  1626. to work,
  1627. <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
  1628. must be set to "1".
  1629. </para>
  1630. <para>
  1631. The repository should correspond to a remote
  1632. address that specifies a repository as understood by
  1633. Git, or alternatively to a remote name that you have
  1634. set up manually using <filename>git remote</filename>
  1635. within the local repository.
  1636. </para>
  1637. <para>
  1638. By default, the <filename>buildhistory</filename> class
  1639. sets the variable as follows:
  1640. <literallayout class='monospaced'>
  1641. BUILDHISTORY_PUSH_REPO ?= ""
  1642. </literallayout>
  1643. </para>
  1644. </glossdef>
  1645. </glossentry>
  1646. <glossentry id='var-BUILDSDK_CFLAGS'><glossterm>BUILDSDK_CFLAGS</glossterm>
  1647. <info>
  1648. BUILDSDK_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the SDK."
  1649. </info>
  1650. <glossdef>
  1651. <para role="glossdeffirst">
  1652. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1653. Specifies the flags to pass to the C compiler when building
  1654. for the SDK.
  1655. When building in the <filename>nativesdk-</filename>
  1656. context,
  1657. <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
  1658. is set to the value of this variable by default.
  1659. </para>
  1660. </glossdef>
  1661. </glossentry>
  1662. <glossentry id='var-BUILDSDK_CPPFLAGS'><glossterm>BUILDSDK_CPPFLAGS</glossterm>
  1663. <info>
  1664. BUILDSDK_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK."
  1665. </info>
  1666. <glossdef>
  1667. <para role="glossdeffirst">
  1668. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1669. Specifies the flags to pass to the C pre-processor
  1670. (i.e. to both the C and the C++ compilers) when building
  1671. for the SDK.
  1672. When building in the <filename>nativesdk-</filename>
  1673. context,
  1674. <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link>
  1675. is set to the value of this variable by default.
  1676. </para>
  1677. </glossdef>
  1678. </glossentry>
  1679. <glossentry id='var-BUILDSDK_CXXFLAGS'><glossterm>BUILDSDK_CXXFLAGS</glossterm>
  1680. <info>
  1681. BUILDSDK_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the SDK."
  1682. </info>
  1683. <glossdef>
  1684. <para role="glossdeffirst">
  1685. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1686. Specifies the flags to pass to the C++ compiler when
  1687. building for the SDK.
  1688. When building in the <filename>nativesdk-</filename>
  1689. context,
  1690. <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link>
  1691. is set to the value of this variable by default.
  1692. </para>
  1693. </glossdef>
  1694. </glossentry>
  1695. <glossentry id='var-BUILDSDK_LDFLAGS'><glossterm>BUILDSDK_LDFLAGS</glossterm>
  1696. <info>
  1697. BUILDSDK_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the SDK."
  1698. </info>
  1699. <glossdef>
  1700. <para role="glossdeffirst">
  1701. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1702. Specifies the flags to pass to the linker when building
  1703. for the SDK.
  1704. When building in the <filename>nativesdk-</filename>
  1705. context,
  1706. <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>
  1707. is set to the value of this variable by default.
  1708. </para>
  1709. </glossdef>
  1710. </glossentry>
  1711. <glossentry id='var-BUILDSTATS_BASE'><glossterm>BUILDSTATS_BASE</glossterm>
  1712. <info>
  1713. BUILDSTATS_BASE[doc] = "Points to the location of the directory that holds build statistics when you use and enable the buildstats class."
  1714. </info>
  1715. <glossdef>
  1716. <para role="glossdeffirst">
  1717. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1718. Points to the location of the directory that holds build
  1719. statistics when you use and enable the
  1720. <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link>
  1721. class.
  1722. The <filename>BUILDSTATS_BASE</filename> directory defaults
  1723. to
  1724. <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/buildstats/</filename>.
  1725. </para>
  1726. </glossdef>
  1727. </glossentry>
  1728. <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm>
  1729. <info>
  1730. BUSYBOX_SPLIT_SUID[doc] = "For the BusyBox recipe, specifies whether to split the output executable file into two parts: one for features that require setuid root, and one for the remaining features."
  1731. </info>
  1732. <glossdef>
  1733. <para role="glossdeffirst">
  1734. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1735. For the BusyBox recipe, specifies whether to split the
  1736. output executable file into two parts: one for features
  1737. that require <filename>setuid root</filename>, and one for
  1738. the remaining features (i.e. those that do not require
  1739. <filename>setuid root</filename>).
  1740. </para>
  1741. <para>
  1742. The <filename>BUSYBOX_SPLIT_SUID</filename> variable
  1743. defaults to "1", which results in a single output
  1744. executable file.
  1745. Set the variable to "0" to split the output file.
  1746. </para>
  1747. </glossdef>
  1748. </glossentry>
  1749. </glossdiv>
  1750. <glossdiv id='var-glossary-c'><title>C</title>
  1751. <glossentry id='var-CACHE'><glossterm>CACHE</glossterm>
  1752. <info>
  1753. CACHE[doc] = "The directory BitBake uses to store a cache of the metadata."
  1754. </info>
  1755. <glossdef>
  1756. <para role="glossdeffirst">
  1757. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1758. Specifies the directory BitBake uses to store a cache
  1759. of the
  1760. <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
  1761. so it does not need to be parsed every time BitBake is
  1762. started.
  1763. </para>
  1764. </glossdef>
  1765. </glossentry>
  1766. <glossentry id='var-CC'><glossterm>CC</glossterm>
  1767. <info>
  1768. CC[doc] = "Minimum command and arguments to run the C compiler."
  1769. </info>
  1770. <glossdef>
  1771. <para role="glossdeffirst">
  1772. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1773. The minimal command and arguments used to run the C
  1774. compiler.
  1775. </para>
  1776. </glossdef>
  1777. </glossentry>
  1778. <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm>
  1779. <info>
  1780. CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS."
  1781. </info>
  1782. <glossdef>
  1783. <para role="glossdeffirst">
  1784. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1785. Specifies the flags to pass to the C compiler.
  1786. This variable is exported to an environment
  1787. variable and thus made visible to the software being
  1788. built during the compilation step.
  1789. </para>
  1790. <para>
  1791. Default initialization for <filename>CFLAGS</filename>
  1792. varies depending on what is being built:
  1793. <itemizedlist>
  1794. <listitem><para>
  1795. <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link>
  1796. when building for the target
  1797. </para></listitem>
  1798. <listitem><para>
  1799. <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link>
  1800. when building for the build host (i.e.
  1801. <filename>-native</filename>)
  1802. </para></listitem>
  1803. <listitem><para>
  1804. <link linkend='var-BUILDSDK_CFLAGS'><filename>BUILDSDK_CFLAGS</filename></link>
  1805. when building for an SDK (i.e.
  1806. <filename>nativesdk-</filename>)
  1807. </para></listitem>
  1808. </itemizedlist>
  1809. </para>
  1810. </glossdef>
  1811. </glossentry>
  1812. <glossentry id='var-CLASSOVERRIDE'><glossterm>CLASSOVERRIDE</glossterm>
  1813. <info>
  1814. CLASSOVERRIDE[doc] = "An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth)."
  1815. </info>
  1816. <glossdef>
  1817. <para role="glossdeffirst">
  1818. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1819. An internal variable specifying the special class override
  1820. that should currently apply (e.g. "class-target",
  1821. "class-native", and so forth).
  1822. The classes that use this variable set it to
  1823. appropriate values.
  1824. </para>
  1825. <para>
  1826. You do not normally directly interact with this variable.
  1827. The value for the <filename>CLASSOVERRIDE</filename>
  1828. variable goes into
  1829. <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
  1830. and then can be used as an override.
  1831. Here is an example where "python-native" is added to
  1832. <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
  1833. only when building for the <filename>-native</filename> case:
  1834. <literallayout class='monospaced'>
  1835. DEPENDS_append_class-native = " python-native"
  1836. </literallayout>
  1837. </para>
  1838. </glossdef>
  1839. </glossentry>
  1840. <glossentry id='var-CLEANBROKEN'><glossterm>CLEANBROKEN</glossterm>
  1841. <info>
  1842. CLEANBROKEN[doc] = "Prevents the build system from running 'make clean' during the do_configure task."
  1843. </info>
  1844. <glossdef>
  1845. <para role="glossdeffirst">
  1846. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1847. If set to "1" within a recipe,
  1848. <filename>CLEANBROKEN</filename> specifies that
  1849. the <filename>make clean</filename> command does
  1850. not work for the software being built.
  1851. Consequently, the OpenEmbedded build system will not try
  1852. to run <filename>make clean</filename> during the
  1853. <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
  1854. task, which is the default behavior.
  1855. </para>
  1856. </glossdef>
  1857. </glossentry>
  1858. <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm>
  1859. <info>
  1860. COMBINED_FEATURES[doc] = "A set of features common between MACHINE_FEATURES and DISTRO_FEATURES."
  1861. </info>
  1862. <glossdef>
  1863. <para role="glossdeffirst">
  1864. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1865. Provides a list of hardware features that are enabled in
  1866. both
  1867. <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
  1868. and
  1869. <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
  1870. This select list of features contains features that make
  1871. sense to be controlled both at the machine and distribution
  1872. configuration level.
  1873. For example, the "bluetooth" feature requires hardware
  1874. support but should also be optional at the distribution
  1875. level, in case the hardware supports Bluetooth but you
  1876. do not ever intend to use it.
  1877. </para>
  1878. <para>
  1879. For more information, see the
  1880. <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
  1881. and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
  1882. variables.
  1883. </para>
  1884. </glossdef>
  1885. </glossentry>
  1886. <glossentry id='var-COMMON_LICENSE_DIR'><glossterm>COMMON_LICENSE_DIR</glossterm>
  1887. <info>
  1888. COMMON_LICENSE_DIR[doc] = "Points to meta/files/common-licenses in the Source Directory, which is where generic license files reside."
  1889. </info>
  1890. <glossdef>
  1891. <para role="glossdeffirst">
  1892. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1893. Points to <filename>meta/files/common-licenses</filename>
  1894. in the
  1895. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
  1896. which is where generic license files reside.
  1897. </para>
  1898. </glossdef>
  1899. </glossentry>
  1900. <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm>
  1901. <info>
  1902. COMPATIBLE_HOST[doc] = "A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible."
  1903. </info>
  1904. <glossdef>
  1905. <para role="glossdeffirst">
  1906. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1907. A regular expression that resolves to one or more hosts
  1908. (when the recipe is native) or one or more targets (when
  1909. the recipe is non-native) with which a recipe is compatible.
  1910. The regular expression is matched against
  1911. <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>.
  1912. You can use the variable to stop recipes from being built
  1913. for classes of systems with which the recipes are not
  1914. compatible.
  1915. Stopping these builds is particularly useful with kernels.
  1916. The variable also helps to increase parsing speed
  1917. since the build system skips parsing recipes not
  1918. compatible with the current system.
  1919. </para>
  1920. </glossdef>
  1921. </glossentry>
  1922. <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
  1923. <info>
  1924. COMPATIBLE_MACHINE[doc] = "A regular expression that resolves to one or more target machines with which a recipe is compatible."
  1925. </info>
  1926. <glossdef>
  1927. <para role="glossdeffirst">
  1928. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1929. A regular expression that resolves to one or more
  1930. target machines with which a recipe is compatible.
  1931. The regular expression is matched against
  1932. <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>.
  1933. You can use the variable to stop recipes from being built
  1934. for machines with which the recipes are not compatible.
  1935. Stopping these builds is particularly useful with kernels.
  1936. The variable also helps to increase parsing speed
  1937. since the build system skips parsing recipes not
  1938. compatible with the current machine.
  1939. </para>
  1940. </glossdef>
  1941. </glossentry>
  1942. <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm>
  1943. <info>
  1944. COMPLEMENTARY_GLOB[doc] = "Defines wildcards to match when installing a list of complementary packages for all the packages installed in an image."
  1945. </info>
  1946. <glossdef>
  1947. <para role="glossdeffirst">
  1948. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1949. Defines wildcards to match when installing a list of
  1950. complementary packages for all the packages explicitly
  1951. (or implicitly) installed in an image.
  1952. The resulting list of complementary packages is associated
  1953. with an item that can be added to
  1954. <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
  1955. An example usage of this is the "dev-pkgs" item that when
  1956. added to <filename>IMAGE_FEATURES</filename> will
  1957. install -dev packages (containing headers and other
  1958. development files) for every package in the image.
  1959. </para>
  1960. <para>
  1961. To add a new feature item pointing to a wildcard, use a
  1962. variable flag to specify the feature item name and
  1963. use the value to specify the wildcard.
  1964. Here is an example:
  1965. <literallayout class='monospaced'>
  1966. COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
  1967. </literallayout>
  1968. </para>
  1969. </glossdef>
  1970. </glossentry>
  1971. <glossentry id='var-CONF_VERSION'><glossterm>CONF_VERSION</glossterm>
  1972. <info>
  1973. CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly."
  1974. </info>
  1975. <glossdef>
  1976. <para role="glossdeffirst">
  1977. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1978. Tracks the version of the local configuration file
  1979. (i.e. <filename>local.conf</filename>).
  1980. The value for <filename>CONF_VERSION</filename>
  1981. increments each time <filename>build/conf/</filename>
  1982. compatibility changes.
  1983. </para>
  1984. </glossdef>
  1985. </glossentry>
  1986. <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm>
  1987. <info>
  1988. CONFFILES[doc] = "Identifies editable or configurable files that are part of a package."
  1989. </info>
  1990. <glossdef>
  1991. <para role="glossdeffirst">
  1992. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  1993. Identifies editable or configurable files that are part of a package.
  1994. If the Package Management System (PMS) is being used to update
  1995. packages on the target system, it is possible that
  1996. configuration files you have changed after the original installation
  1997. and that you now want to remain unchanged are overwritten.
  1998. In other words, editable files might exist in the package that you do not
  1999. want reset as part of the package update process.
  2000. You can use the <filename>CONFFILES</filename> variable to list the files in the
  2001. package that you wish to prevent the PMS from overwriting during this update process.
  2002. </para>
  2003. <para>
  2004. To use the <filename>CONFFILES</filename> variable, provide a package name
  2005. override that identifies the resulting package.
  2006. Then, provide a space-separated list of files.
  2007. Here is an example:
  2008. <literallayout class='monospaced'>
  2009. CONFFILES_${PN} += "${sysconfdir}/file1 \
  2010. ${sysconfdir}/file2 ${sysconfdir}/file3"
  2011. </literallayout>
  2012. </para>
  2013. <para>
  2014. A relationship exists between the <filename>CONFFILES</filename> and
  2015. <filename><link linkend='var-FILES'>FILES</link></filename> variables.
  2016. The files listed within <filename>CONFFILES</filename> must be a subset of
  2017. the files listed within <filename>FILES</filename>.
  2018. Because the configuration files you provide with <filename>CONFFILES</filename>
  2019. are simply being identified so that the PMS will not overwrite them,
  2020. it makes sense that
  2021. the files must already be included as part of the package through the
  2022. <filename>FILES</filename> variable.
  2023. </para>
  2024. <note>
  2025. When specifying paths as part of the <filename>CONFFILES</filename> variable,
  2026. it is good practice to use appropriate path variables.
  2027. For example, <filename>${sysconfdir}</filename> rather than
  2028. <filename>/etc</filename> or <filename>${bindir}</filename> rather
  2029. than <filename>/usr/bin</filename>.
  2030. You can find a list of these variables at the top of the
  2031. <filename>meta/conf/bitbake.conf</filename> file in the
  2032. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  2033. </note>
  2034. </glossdef>
  2035. </glossentry>
  2036. <glossentry id='var-CONFIG_INITRAMFS_SOURCE'><glossterm>CONFIG_INITRAMFS_SOURCE</glossterm>
  2037. <info>
  2038. CONFIG_INITRAMFS_SOURCE[doc] = "Identifies the initial RAM disk (initramfs) source files. The OpenEmbedded build system receives and uses this kernel Kconfig variable as an environment variable."
  2039. </info>
  2040. <glossdef>
  2041. <para role="glossdeffirst">
  2042. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2043. Identifies the initial RAM disk (initramfs) source files.
  2044. The OpenEmbedded build system receives and uses
  2045. this kernel Kconfig variable as an environment variable.
  2046. By default, the variable is set to null ("").
  2047. </para>
  2048. <para>
  2049. The <filename>CONFIG_INITRAMFS_SOURCE</filename> can be
  2050. either a single cpio archive with a
  2051. <filename>.cpio</filename> suffix or a
  2052. space-separated list of directories and files for building
  2053. the initramfs image.
  2054. A cpio archive should contain a filesystem archive
  2055. to be used as an initramfs image.
  2056. Directories should contain a filesystem layout to be
  2057. included in the initramfs image.
  2058. Files should contain entries according to the format
  2059. described by the
  2060. <filename>usr/gen_init_cpio</filename> program in the
  2061. kernel tree.
  2062. </para>
  2063. <para>
  2064. If you specify multiple directories and files, the
  2065. initramfs image will be the aggregate of all of them.
  2066. </para>
  2067. </glossdef>
  2068. </glossentry>
  2069. <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm>
  2070. <info>
  2071. CONFIG_SITE[doc] = "A list of files that contains autoconf test results relevant to the current build. This variable is used by the Autotools utilities when running configure."
  2072. </info>
  2073. <glossdef>
  2074. <para role="glossdeffirst">
  2075. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2076. A list of files that contains <filename>autoconf</filename> test results relevant
  2077. to the current build.
  2078. This variable is used by the Autotools utilities when running
  2079. <filename>configure</filename>.
  2080. </para>
  2081. </glossdef>
  2082. </glossentry>
  2083. <glossentry id='var-CONFIGURE_FLAGS'><glossterm>CONFIGURE_FLAGS</glossterm>
  2084. <info>
  2085. CONFIGURE_FLAGS[doc] = "The minimal arguments for GNU configure."
  2086. </info>
  2087. <glossdef>
  2088. <para role="glossdeffirst">
  2089. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2090. The minimal arguments for GNU configure.
  2091. </para>
  2092. </glossdef>
  2093. </glossentry>
  2094. <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm>
  2095. <info>
  2096. CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that would be in conflict should the recipe be built."
  2097. </info>
  2098. <glossdef>
  2099. <para role="glossdeffirst">
  2100. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2101. When inheriting the
  2102. <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link>
  2103. class, this
  2104. variable identifies distribution features that would
  2105. be in conflict should the recipe
  2106. be built.
  2107. In other words, if the
  2108. <filename>CONFLICT_DISTRO_FEATURES</filename> variable
  2109. lists a feature that also appears in
  2110. <filename>DISTRO_FEATURES</filename> within the
  2111. current configuration, an error occurs and the
  2112. build stops.
  2113. </para>
  2114. </glossdef>
  2115. </glossentry>
  2116. <glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm>
  2117. <info>
  2118. COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package."
  2119. </info>
  2120. <glossdef>
  2121. <para role="glossdeffirst">
  2122. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2123. If set to "1" along with the
  2124. <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link>
  2125. variable, the OpenEmbedded build system copies
  2126. into the image the license files, which are located in
  2127. <filename>/usr/share/common-licenses</filename>,
  2128. for each package.
  2129. The license files are placed
  2130. in directories within the image itself during build time.
  2131. <note>
  2132. The <filename>COPY_LIC_DIRS</filename> does not
  2133. offer a path for adding licenses for newly installed
  2134. packages to an image, which might be most suitable
  2135. for read-only filesystems that cannot be upgraded.
  2136. See the
  2137. <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link>
  2138. variable for additional information.
  2139. You can also reference the
  2140. "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>"
  2141. section in the Yocto Project Development Manual for
  2142. information on providing license text.
  2143. </note>
  2144. </para>
  2145. </glossdef>
  2146. </glossentry>
  2147. <glossentry id='var-COPY_LIC_MANIFEST'><glossterm>COPY_LIC_MANIFEST</glossterm>
  2148. <info>
  2149. COPY_LIC_MANIFEST[doc] = "If set to "1", the OpenEmbedded build system copies the license manifest for the image to /usr/share/common-licenses/license.manifest within the image itself."
  2150. </info>
  2151. <glossdef>
  2152. <para role="glossdeffirst">
  2153. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2154. If set to "1", the OpenEmbedded build system copies
  2155. the license manifest for the image to
  2156. <filename>/usr/share/common-licenses/license.manifest</filename>
  2157. within the image itself during build time.
  2158. <note>
  2159. The <filename>COPY_LIC_MANIFEST</filename> does not
  2160. offer a path for adding licenses for newly installed
  2161. packages to an image, which might be most suitable
  2162. for read-only filesystems that cannot be upgraded.
  2163. See the
  2164. <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link>
  2165. variable for additional information.
  2166. You can also reference the
  2167. "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>"
  2168. section in the Yocto Project Development Manual for
  2169. information on providing license text.
  2170. </note>
  2171. </para>
  2172. </glossdef>
  2173. </glossentry>
  2174. <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm>
  2175. <info>
  2176. CORE_IMAGE_EXTRA_INSTALL[doc] = "Specifies the list of packages to be added to the image. You should only set this variable in the conf/local.conf file in the Build Directory."
  2177. </info>
  2178. <glossdef>
  2179. <para role="glossdeffirst">
  2180. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2181. Specifies the list of packages to be added to the image.
  2182. You should only set this variable in the
  2183. <filename>local.conf</filename> configuration file found
  2184. in the
  2185. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  2186. </para>
  2187. <para>
  2188. This variable replaces <filename>POKY_EXTRA_INSTALL</filename>, which is no longer supported.
  2189. </para>
  2190. </glossdef>
  2191. </glossentry>
  2192. <glossentry id='var-COREBASE'><glossterm>COREBASE</glossterm>
  2193. <info>
  2194. COREBASE[doc] = "Specifies the parent directory of the OpenEmbedded Core Metadata layer (i.e. meta)."
  2195. </info>
  2196. <glossdef>
  2197. <para role="glossdeffirst">
  2198. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2199. Specifies the parent directory of the OpenEmbedded
  2200. Core Metadata layer (i.e. <filename>meta</filename>).
  2201. </para>
  2202. <para>
  2203. It is an important distinction that
  2204. <filename>COREBASE</filename> points to the parent of this
  2205. layer and not the layer itself.
  2206. Consider an example where you have cloned the Poky Git
  2207. repository and retained the <filename>poky</filename>
  2208. name for your local copy of the repository.
  2209. In this case, <filename>COREBASE</filename> points to
  2210. the <filename>poky</filename> folder because it is the
  2211. parent directory of the <filename>poky/meta</filename>
  2212. layer.
  2213. </para>
  2214. </glossdef>
  2215. </glossentry>
  2216. <glossentry id='var-COREBASE_FILES'><glossterm>COREBASE_FILES</glossterm>
  2217. <info>
  2218. COREBASE_FILES[doc] = "Lists files from the COREBASE directory that should be copied other than the layers listed in the bblayers.conf file."
  2219. </info>
  2220. <glossdef>
  2221. <para role="glossdeffirst">
  2222. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2223. Lists files from the
  2224. <link linkend='var-COREBASE'><filename>COREBASE</filename></link>
  2225. directory that should be copied other than the layers
  2226. listed in the <filename>bblayers.conf</filename> file.
  2227. The <filename>COREBASE_FILES</filename> variable exists
  2228. for the purpose of copying metadata from the
  2229. OpenEmbedded build system into the extensible
  2230. SDK.
  2231. </para>
  2232. <para>
  2233. Explicitly listing files in <filename>COREBASE</filename>
  2234. is needed because it typically contains build
  2235. directories and other files that should not normally
  2236. be copied into the extensible SDK.
  2237. Consequently, the value of
  2238. <filename>COREBASE_FILES</filename> is used in order to
  2239. only copy the files that are actually needed.
  2240. </para>
  2241. </glossdef>
  2242. </glossentry>
  2243. <glossentry id='var-CPP'><glossterm>CPP</glossterm>
  2244. <info>
  2245. CPP[doc] = "Minimum command and arguments to run the C preprocessor."
  2246. </info>
  2247. <glossdef>
  2248. <para role="glossdeffirst">
  2249. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2250. The minimal command and arguments used to run the C
  2251. preprocessor.
  2252. </para>
  2253. </glossdef>
  2254. </glossentry>
  2255. <glossentry id='var-CPPFLAGS'><glossterm>CPPFLAGS</glossterm>
  2256. <info>
  2257. CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers)."
  2258. </info>
  2259. <glossdef>
  2260. <para role="glossdeffirst">
  2261. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2262. Specifies the flags to pass to the C pre-processor
  2263. (i.e. to both the C and the C++ compilers).
  2264. This variable is exported to an environment
  2265. variable and thus made visible to the software being
  2266. built during the compilation step.
  2267. </para>
  2268. <para>
  2269. Default initialization for <filename>CPPFLAGS</filename>
  2270. varies depending on what is being built:
  2271. <itemizedlist>
  2272. <listitem><para>
  2273. <link linkend='var-TARGET_CPPFLAGS'><filename>TARGET_CPPFLAGS</filename></link>
  2274. when building for the target
  2275. </para></listitem>
  2276. <listitem><para>
  2277. <link linkend='var-BUILD_CPPFLAGS'><filename>BUILD_CPPFLAGS</filename></link>
  2278. when building for the build host (i.e.
  2279. <filename>-native</filename>)
  2280. </para></listitem>
  2281. <listitem><para>
  2282. <link linkend='var-BUILDSDK_CPPFLAGS'><filename>BUILDSDK_CPPFLAGS</filename></link>
  2283. when building for an SDK (i.e.
  2284. <filename>nativesdk-</filename>)
  2285. </para></listitem>
  2286. </itemizedlist>
  2287. </para>
  2288. </glossdef>
  2289. </glossentry>
  2290. <glossentry id='var-CROSS_COMPILE'><glossterm>CROSS_COMPILE</glossterm>
  2291. <info>
  2292. CROSS_COMPILE[doc] = "The toolchain binary prefix for the target tools."
  2293. </info>
  2294. <glossdef>
  2295. <para role="glossdeffirst">
  2296. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2297. The toolchain binary prefix for the target tools.
  2298. The <filename>CROSS_COMPILE</filename> variable is the
  2299. same as the
  2300. <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>
  2301. variable.
  2302. <note>
  2303. The OpenEmbedded build system sets the
  2304. <filename>CROSS_COMPILE</filename> variable only in
  2305. certain contexts (e.g. when building for kernel
  2306. and kernel module recipes).
  2307. </note>
  2308. </para>
  2309. </glossdef>
  2310. </glossentry>
  2311. <glossentry id='var-CVSDIR'><glossterm>CVSDIR</glossterm>
  2312. <info>
  2313. CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
  2314. </info>
  2315. <glossdef>
  2316. <para role="glossdeffirst">
  2317. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2318. The directory in which files checked out under the
  2319. CVS system are stored.
  2320. </para>
  2321. </glossdef>
  2322. </glossentry>
  2323. <glossentry id='var-CXX'><glossterm>CXX</glossterm>
  2324. <info>
  2325. CXX[doc] = "Minimum command and arguments to run the C++ compiler."
  2326. </info>
  2327. <glossdef>
  2328. <para role="glossdeffirst">
  2329. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2330. The minimal command and arguments used to run the C++
  2331. compiler.
  2332. </para>
  2333. </glossdef>
  2334. </glossentry>
  2335. <glossentry id='var-CXXFLAGS'><glossterm>CXXFLAGS</glossterm>
  2336. <info>
  2337. CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler."
  2338. </info>
  2339. <glossdef>
  2340. <para role="glossdeffirst">
  2341. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2342. Specifies the flags to pass to the C++ compiler.
  2343. This variable is exported to an environment
  2344. variable and thus made visible to the software being
  2345. built during the compilation step.
  2346. </para>
  2347. <para>
  2348. Default initialization for <filename>CXXFLAGS</filename>
  2349. varies depending on what is being built:
  2350. <itemizedlist>
  2351. <listitem><para>
  2352. <link linkend='var-TARGET_CXXFLAGS'><filename>TARGET_CXXFLAGS</filename></link>
  2353. when building for the target
  2354. </para></listitem>
  2355. <listitem><para>
  2356. <link linkend='var-BUILD_CXXFLAGS'><filename>BUILD_CXXFLAGS</filename></link>
  2357. when building for the build host (i.e.
  2358. <filename>-native</filename>)
  2359. </para></listitem>
  2360. <listitem><para>
  2361. <link linkend='var-BUILDSDK_CXXFLAGS'><filename>BUILDSDK_CXXFLAGS</filename></link>
  2362. when building for an SDK (i.e.
  2363. <filename>nativesdk-</filename>)
  2364. </para></listitem>
  2365. </itemizedlist>
  2366. </para>
  2367. </glossdef>
  2368. </glossentry>
  2369. </glossdiv>
  2370. <glossdiv id='var-glossary-d'><title>D</title>
  2371. <glossentry id='var-D'><glossterm>D</glossterm>
  2372. <info>
  2373. D[doc] = "The destination directory."
  2374. </info>
  2375. <glossdef>
  2376. <para role="glossdeffirst">
  2377. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2378. The destination directory.
  2379. The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
  2380. where components are installed by the
  2381. <link linkend='ref-tasks-install'><filename>do_install</filename></link>
  2382. task.
  2383. This location defaults to:
  2384. <literallayout class='monospaced'>
  2385. ${WORKDIR}/image
  2386. </literallayout>
  2387. </para>
  2388. </glossdef>
  2389. </glossentry>
  2390. <glossentry id='var-DATE'><glossterm>DATE</glossterm>
  2391. <info>
  2392. DATE[doc] = "The date the build was started using YMD format."
  2393. </info>
  2394. <glossdef>
  2395. <para role="glossdeffirst">
  2396. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2397. The date the build was started.
  2398. Dates appear using the year, month, and day (YMD) format
  2399. (e.g. "20150209" for February 9th, 2015).
  2400. </para>
  2401. </glossdef>
  2402. </glossentry>
  2403. <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm>
  2404. <info>
  2405. DATETIME[doc] = "The date and time the build was started."
  2406. </info>
  2407. <glossdef>
  2408. <para role="glossdeffirst">
  2409. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2410. The date and time on which the current build started.
  2411. The format is suitable for timestamps.
  2412. </para>
  2413. </glossdef>
  2414. </glossentry>
  2415. <glossentry id='var-DEBIAN_NOAUTONAME'><glossterm>DEBIAN_NOAUTONAME</glossterm>
  2416. <info>
  2417. DEBIAN_NOAUTONAME[doc] = "Prevents a particular package from being renamed according to Debian package naming."
  2418. </info>
  2419. <glossdef>
  2420. <para role="glossdeffirst">
  2421. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2422. When the
  2423. <link linkend='ref-classes-debian'><filename>debian</filename></link>
  2424. class is inherited, which is the default behavior,
  2425. <filename>DEBIAN_NOAUTONAME</filename> specifies a
  2426. particular package should not be renamed according to
  2427. Debian library package naming.
  2428. You must use the package name as an override when you
  2429. set this variable.
  2430. Here is an example from the <filename>fontconfig</filename>
  2431. recipe:
  2432. <literallayout class='monospaced'>
  2433. DEBIAN_NOAUTONAME_fontconfig-utils = "1"
  2434. </literallayout>
  2435. </para>
  2436. </glossdef>
  2437. </glossentry>
  2438. <glossentry id='var-DEBIANNAME'><glossterm>DEBIANNAME</glossterm>
  2439. <info>
  2440. DEBIANNAME[doc] = "Allows you to override the library name for an individual package for Debian library package renaming."
  2441. </info>
  2442. <glossdef>
  2443. <para role="glossdeffirst">
  2444. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2445. When the
  2446. <link linkend='ref-classes-debian'><filename>debian</filename></link>
  2447. class is inherited, which is the default behavior,
  2448. <filename>DEBIANNAME</filename> allows you to override the
  2449. library name for an individual package.
  2450. Overriding the library name in these cases is rare.
  2451. You must use the package name as an override when you
  2452. set this variable.
  2453. Here is an example from the <filename>dbus</filename>
  2454. recipe:
  2455. <literallayout class='monospaced'>
  2456. DEBIANNAME_${PN} = "dbus-1"
  2457. </literallayout>
  2458. </para>
  2459. </glossdef>
  2460. </glossentry>
  2461. <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
  2462. <info>
  2463. DEBUG_BUILD[doc] = "Specifies to build packages with debugging information. This influences the value of the SELECTED_OPTIMIZATION variable."
  2464. </info>
  2465. <glossdef>
  2466. <para role="glossdeffirst">
  2467. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2468. Specifies to build packages with debugging information.
  2469. This influences the value of the
  2470. <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename>
  2471. variable.
  2472. </para>
  2473. </glossdef>
  2474. </glossentry>
  2475. <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm>
  2476. <info>
  2477. DEBUG_OPTIMIZATION[doc] = "The options to pass in TARGET_CFLAGS and CFLAGS when compiling a system for debugging. This variable defaults to '-O -fno-omit-frame-pointer -g'."
  2478. </info>
  2479. <glossdef>
  2480. <para role="glossdeffirst">
  2481. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2482. The options to pass in
  2483. <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
  2484. and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling
  2485. a system for debugging.
  2486. This variable defaults to "-O -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
  2487. </para>
  2488. </glossdef>
  2489. </glossentry>
  2490. <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
  2491. <info>
  2492. DEFAULT_PREFERENCE[doc] = "Specifies a weak bias for recipe selection priority."
  2493. </info>
  2494. <glossdef>
  2495. <para role="glossdeffirst">
  2496. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2497. Specifies a weak bias for recipe selection priority.
  2498. </para>
  2499. <para>
  2500. The most common usage of this is variable is to set
  2501. it to "-1" within a recipe for a development version of a
  2502. piece of software.
  2503. Using the variable in this way causes the stable version
  2504. of the recipe to build by default in the absence of
  2505. <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename>
  2506. being used to build the development version.
  2507. </para>
  2508. <note>
  2509. The bias provided by <filename>DEFAULT_PREFERENCE</filename>
  2510. is weak and is overridden by
  2511. <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename>
  2512. if that variable is different between two layers
  2513. that contain different versions of the same recipe.
  2514. </note>
  2515. </glossdef>
  2516. </glossentry>
  2517. <glossentry id='var-DEFAULTTUNE'><glossterm>DEFAULTTUNE</glossterm>
  2518. <info>
  2519. DEFAULTTUNE[doc] = "The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system."
  2520. </info>
  2521. <glossdef>
  2522. <para role="glossdeffirst">
  2523. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2524. The default CPU and Application Binary Interface (ABI)
  2525. tunings (i.e. the "tune") used by the OpenEmbedded build
  2526. system.
  2527. The <filename>DEFAULTTUNE</filename> helps define
  2528. <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
  2529. </para>
  2530. <para>
  2531. The default tune is either implicitly or explicitly set
  2532. by the machine
  2533. (<link linkend='var-MACHINE'><filename>MACHINE</filename></link>).
  2534. However, you can override the setting using available tunes
  2535. as defined with
  2536. <link linkend='var-AVAILTUNES'><filename>AVAILTUNES</filename></link>.
  2537. </para>
  2538. </glossdef>
  2539. </glossentry>
  2540. <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
  2541. <info>
  2542. DEPENDS[doc] = "Lists a recipe's build-time dependencies (i.e. other recipe files)."
  2543. </info>
  2544. <glossdef>
  2545. <para role="glossdeffirst">
  2546. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2547. Lists a recipe's build-time dependencies
  2548. (i.e. other recipe files).
  2549. The system ensures that all the dependencies listed
  2550. have been built and have their contents in the appropriate
  2551. sysroots before the recipe's configure task is executed.
  2552. </para>
  2553. <para>
  2554. Consider this simple example for two recipes named "a" and
  2555. "b" that produce similarly named packages.
  2556. In this example, the <filename>DEPENDS</filename>
  2557. statement appears in the "a" recipe:
  2558. <literallayout class='monospaced'>
  2559. DEPENDS = "b"
  2560. </literallayout>
  2561. Here, the dependency is such that the
  2562. <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
  2563. task for recipe "a" depends on the
  2564. <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
  2565. task of recipe "b".
  2566. This means anything that recipe "b" puts into sysroot
  2567. is available when recipe "a" is configuring itself.
  2568. </para>
  2569. <para>
  2570. For information on runtime dependencies, see the
  2571. <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
  2572. variable.
  2573. </para>
  2574. </glossdef>
  2575. </glossentry>
  2576. <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm>
  2577. <info>
  2578. DEPLOY_DIR[doc] = "Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
  2579. </info>
  2580. <glossdef>
  2581. <para role="glossdeffirst">
  2582. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2583. Points to the general area that the OpenEmbedded build
  2584. system uses to place images, packages, SDKs and other output
  2585. files that are ready to be used outside of the build system.
  2586. By default, this directory resides within the
  2587. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
  2588. as <filename>${TMPDIR}/deploy</filename>.
  2589. </para>
  2590. <para>
  2591. For more information on the structure of the Build
  2592. Directory, see
  2593. "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>"
  2594. section.
  2595. For more detail on the contents of the
  2596. <filename>deploy</filename> directory, see the
  2597. "<link linkend='images-dev-environment'>Images</link>",
  2598. "<link linkend='package-feeds-dev-environment'>Package Feeds</link>",
  2599. and
  2600. "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
  2601. sections.
  2602. </para>
  2603. </glossdef>
  2604. </glossentry>
  2605. <glossentry id='var-DEPLOY_DIR_DEB'><glossterm>DEPLOY_DIR_DEB</glossterm>
  2606. <info>
  2607. DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
  2608. </info>
  2609. <glossdef>
  2610. <para role="glossdeffirst">
  2611. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2612. Points to the area that the OpenEmbedded build system uses
  2613. to place Debian packages that are ready to be used outside
  2614. of the build system.
  2615. This variable applies only when
  2616. <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
  2617. contains "package_deb".
  2618. </para>
  2619. <para>
  2620. The BitBake configuration file initially defines the
  2621. <filename>DEPLOY_DIR_DEB</filename> variable as a
  2622. sub-folder of
  2623. <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
  2624. <literallayout class='monospaced'>
  2625. DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
  2626. </literallayout>
  2627. </para>
  2628. <para>
  2629. The
  2630. <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>
  2631. class uses the
  2632. <filename>DEPLOY_DIR_DEB</filename> variable to make sure
  2633. the
  2634. <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>
  2635. task writes Debian packages into the appropriate folder.
  2636. For more information on how packaging works, see the
  2637. "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
  2638. section.
  2639. </para>
  2640. </glossdef>
  2641. </glossentry>
  2642. <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm>
  2643. <info>
  2644. DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine."
  2645. </info>
  2646. <glossdef>
  2647. <para role="glossdeffirst">
  2648. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2649. Points to the area that the OpenEmbedded build system uses
  2650. to place images and other associated output files that are
  2651. ready to be deployed onto the target machine.
  2652. The directory is machine-specific as it contains the
  2653. <filename>${MACHINE}</filename> name.
  2654. By default, this directory resides within the
  2655. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
  2656. as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>.
  2657. </para>
  2658. <para>
  2659. For more information on the structure of the Build
  2660. Directory, see
  2661. "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>"
  2662. section.
  2663. For more detail on the contents of the
  2664. <filename>deploy</filename> directory, see the
  2665. "<link linkend='images-dev-environment'>Images</link>" and
  2666. "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
  2667. sections.
  2668. </para>
  2669. </glossdef>
  2670. </glossentry>
  2671. <glossentry id='var-DEPLOY_DIR_IPK'><glossterm>DEPLOY_DIR_IPK</glossterm>
  2672. <info>
  2673. DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
  2674. </info>
  2675. <glossdef>
  2676. <para role="glossdeffirst">
  2677. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2678. Points to the area that the OpenEmbedded build system uses
  2679. to place IPK packages that are ready to be used outside of
  2680. the build system.
  2681. This variable applies only when
  2682. <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
  2683. contains "package_ipk".
  2684. </para>
  2685. <para>
  2686. The BitBake configuration file initially defines this
  2687. variable as a sub-folder of
  2688. <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
  2689. <literallayout class='monospaced'>
  2690. DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk"
  2691. </literallayout>
  2692. </para>
  2693. <para>
  2694. The
  2695. <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>
  2696. class uses the
  2697. <filename>DEPLOY_DIR_IPK</filename> variable to make sure
  2698. the
  2699. <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>
  2700. task writes IPK packages into the appropriate folder.
  2701. For more information on how packaging works, see the
  2702. "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
  2703. section.
  2704. </para>
  2705. </glossdef>
  2706. </glossentry>
  2707. <glossentry id='var-DEPLOY_DIR_RPM'><glossterm>DEPLOY_DIR_RPM</glossterm>
  2708. <info>
  2709. DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
  2710. </info>
  2711. <glossdef>
  2712. <para role="glossdeffirst">
  2713. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2714. Points to the area that the OpenEmbedded build system uses
  2715. to place RPM packages that are ready to be used outside
  2716. of the build system.
  2717. This variable applies only when
  2718. <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
  2719. contains "package_rpm".
  2720. </para>
  2721. <para>
  2722. The BitBake configuration file initially defines this
  2723. variable as a sub-folder of
  2724. <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
  2725. <literallayout class='monospaced'>
  2726. DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm"
  2727. </literallayout>
  2728. </para>
  2729. <para>
  2730. The
  2731. <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>
  2732. class uses the
  2733. <filename>DEPLOY_DIR_RPM</filename> variable to make sure
  2734. the
  2735. <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>
  2736. task writes RPM packages into the appropriate folder.
  2737. For more information on how packaging works, see the
  2738. "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
  2739. section.
  2740. </para>
  2741. </glossdef>
  2742. </glossentry>
  2743. <glossentry id='var-DEPLOY_DIR_TAR'><glossterm>DEPLOY_DIR_TAR</glossterm>
  2744. <info>
  2745. DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
  2746. </info>
  2747. <glossdef>
  2748. <para role="glossdeffirst">
  2749. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2750. Points to the area that the OpenEmbedded build system uses
  2751. to place tarballs that are ready to be used outside of
  2752. the build system.
  2753. This variable applies only when
  2754. <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
  2755. contains "package_tar".
  2756. </para>
  2757. <para>
  2758. The BitBake configuration file initially defines this
  2759. variable as a sub-folder of
  2760. <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
  2761. <literallayout class='monospaced'>
  2762. DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar"
  2763. </literallayout>
  2764. </para>
  2765. <para>
  2766. The
  2767. <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>
  2768. class uses the
  2769. <filename>DEPLOY_DIR_TAR</filename> variable to make sure
  2770. the
  2771. <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>
  2772. task writes TAR packages into the appropriate folder.
  2773. For more information on how packaging works, see the
  2774. "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
  2775. section.
  2776. </para>
  2777. </glossdef>
  2778. </glossentry>
  2779. <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm>
  2780. <info>
  2781. DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files."
  2782. </info>
  2783. <glossdef>
  2784. <para role="glossdeffirst">
  2785. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2786. When inheriting the
  2787. <link linkend='ref-classes-deploy'><filename>deploy</filename></link>
  2788. class, the <filename>DEPLOYDIR</filename> points to a
  2789. temporary work area for deployed files that is set in the
  2790. <filename>deploy</filename> class as follows:
  2791. <literallayout class='monospaced'>
  2792. DEPLOYDIR = "${WORKDIR}/deploy-${<link linkend='var-PN'><filename>PN</filename></link>}"
  2793. </literallayout>
  2794. </para>
  2795. <para>
  2796. Recipes inheriting the <filename>deploy</filename> class
  2797. should copy files to be deployed into
  2798. <filename>DEPLOYDIR</filename>, and the class will take
  2799. care of copying them into
  2800. <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
  2801. afterwards.
  2802. </para>
  2803. </glossdef>
  2804. </glossentry>
  2805. <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
  2806. <info>
  2807. DESCRIPTION[doc] = "The package description used by package managers. If not set, DESCRIPTION takes the value of the SUMMARY variable."
  2808. </info>
  2809. <glossdef>
  2810. <para role="glossdeffirst">
  2811. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2812. The package description used by package managers.
  2813. If not set, <filename>DESCRIPTION</filename> takes
  2814. the value of the
  2815. <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>
  2816. variable.
  2817. </para>
  2818. </glossdef>
  2819. </glossentry>
  2820. <glossentry id='var-DISK_SIGNATURE'><glossterm>DISK_SIGNATURE</glossterm>
  2821. <info>
  2822. DISK_SIGNATURE[doc] = "A 32-bit MBR disk signature used by directdisk images."
  2823. </info>
  2824. <glossdef>
  2825. <para role="glossdeffirst">
  2826. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2827. A 32-bit MBR disk signature used by
  2828. <filename>directdisk</filename> images.
  2829. </para>
  2830. <para>
  2831. By default, the signature is set to an automatically
  2832. generated random value that allows the OpenEmbedded
  2833. build system to create a boot loader.
  2834. You can override the signature in the image recipe
  2835. by setting <filename>DISK_SIGNATURE</filename> to an
  2836. 8-digit hex string.
  2837. You might want to override
  2838. <filename>DISK_SIGNATURE</filename> if you want the disk
  2839. signature to remain constant between image builds.
  2840. </para>
  2841. <para>
  2842. When using Linux 3.8 or later, you can use
  2843. <filename>DISK_SIGNATURE</filename> to specify the root
  2844. by UUID to allow the kernel to locate the root device
  2845. even if the device name changes due to differences in
  2846. hardware configuration.
  2847. By default, <filename>SYSLINUX_ROOT</filename> is set
  2848. as follows:
  2849. <literallayout class='monospaced'>
  2850. SYSLINUX_ROOT = "root=/dev/sda2"
  2851. </literallayout>
  2852. However, you can change this to locate the root device
  2853. using the disk signature instead:
  2854. <literallayout class='monospaced'>
  2855. SYSLINUX_ROOT = "root=PARTUUID=${DISK_SIGNATURE}-02"
  2856. </literallayout>
  2857. </para>
  2858. <para>
  2859. As previously mentioned, it is possible to set the
  2860. <filename>DISK_SIGNATURE</filename> variable in your
  2861. <filename>local.conf</filename> file to a fixed
  2862. value if you do not want <filename>syslinux.cfg</filename>
  2863. changing for each build.
  2864. You might find this useful when you want to upgrade the
  2865. root filesystem on a device without having to recreate or
  2866. modify the master boot record.
  2867. </para>
  2868. </glossdef>
  2869. </glossentry>
  2870. <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
  2871. <info>
  2872. DISTRO[doc] = "The short name of the distribution. If the variable is blank, meta/conf/distro/defaultsetup.conf will be used."
  2873. </info>
  2874. <glossdef>
  2875. <para role="glossdeffirst">
  2876. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2877. The short name of the distribution.
  2878. This variable corresponds to a distribution
  2879. configuration file whose root name is the same as the
  2880. variable's argument and whose filename extension is
  2881. <filename>.conf</filename>.
  2882. For example, the distribution configuration file for the
  2883. Poky distribution is named <filename>poky.conf</filename>
  2884. and resides in the
  2885. <filename>meta-poky/conf/distro</filename> directory of
  2886. the
  2887. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  2888. </para>
  2889. <para>
  2890. Within that <filename>poky.conf</filename> file, the
  2891. <filename>DISTRO</filename> variable is set as follows:
  2892. <literallayout class='monospaced'>
  2893. DISTRO = "poky"
  2894. </literallayout>
  2895. </para>
  2896. <para>
  2897. Distribution configuration files are located in a
  2898. <filename>conf/distro</filename> directory within the
  2899. <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
  2900. that contains the distribution configuration.
  2901. The value for <filename>DISTRO</filename> must not contain
  2902. spaces, and is typically all lower-case.
  2903. <note>
  2904. If the <filename>DISTRO</filename> variable is blank, a set
  2905. of default configurations are used, which are specified
  2906. within
  2907. <filename>meta/conf/distro/defaultsetup.conf</filename>
  2908. also in the Source Directory.
  2909. </note>
  2910. </para>
  2911. </glossdef>
  2912. </glossentry>
  2913. <glossentry id='var-DISTRO_CODENAME'><glossterm>DISTRO_CODENAME</glossterm>
  2914. <info>
  2915. DISTRO_CODENAME[doc] = "Specifies a codename for the distribution being built."
  2916. </info>
  2917. <glossdef>
  2918. <para role="glossdeffirst">
  2919. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2920. Specifies a codename for the distribution being built.
  2921. </para>
  2922. </glossdef>
  2923. </glossentry>
  2924. <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm>
  2925. <info>
  2926. DISTRO_EXTRA_RDEPENDS[doc] = "Specifies a list of distro-specific packages to add to all images. The variable only applies to the images that include packagegroup-base."
  2927. </info>
  2928. <glossdef>
  2929. <para role="glossdeffirst">
  2930. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2931. Specifies a list of distro-specific packages to add to all images.
  2932. This variable takes affect through
  2933. <filename>packagegroup-base</filename> so the
  2934. variable only really applies to the more full-featured
  2935. images that include <filename>packagegroup-base</filename>.
  2936. You can use this variable to keep distro policy out of
  2937. generic images.
  2938. As with all other distro variables, you set this variable
  2939. in the distro <filename>.conf</filename> file.
  2940. </para>
  2941. </glossdef>
  2942. </glossentry>
  2943. <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm>
  2944. <info>
  2945. DISTRO_EXTRA_RRECOMMENDS[doc] = "Specifies a list of distro-specific packages to add to all images if the packages exist. The list of packages are automatically installed but you can remove them."
  2946. </info>
  2947. <glossdef>
  2948. <para role="glossdeffirst">
  2949. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2950. Specifies a list of distro-specific packages to add to all images
  2951. if the packages exist.
  2952. The packages might not exist or be empty (e.g. kernel modules).
  2953. The list of packages are automatically installed but you can
  2954. remove them.
  2955. </para>
  2956. </glossdef>
  2957. </glossentry>
  2958. <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
  2959. <info>
  2960. DISTRO_FEATURES[doc] = "The features enabled for the distribution."
  2961. </info>
  2962. <glossdef>
  2963. <para role="glossdeffirst">
  2964. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2965. The software support you want in your distribution for
  2966. various features.
  2967. You define your distribution features in the distribution
  2968. configuration file.
  2969. </para>
  2970. <para>
  2971. In most cases, the presence or absence of a feature in
  2972. <filename>DISTRO_FEATURES</filename> is translated to the
  2973. appropriate option supplied to the configure script
  2974. during the
  2975. <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
  2976. task for recipes that optionally support the feature.
  2977. For example, specifying "x11" in
  2978. <filename>DISTRO_FEATURES</filename>, causes
  2979. every piece of software built for the target that can
  2980. optionally support X11 to have its X11 support enabled.
  2981. </para>
  2982. <para>
  2983. Two more examples are Bluetooth and NFS support.
  2984. For a more complete list of features that ships with the
  2985. Yocto Project and that you can provide with this variable,
  2986. see the
  2987. "<link linkend='ref-features-distro'>Distro Features</link>"
  2988. section.
  2989. </para>
  2990. </glossdef>
  2991. </glossentry>
  2992. <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm>
  2993. <info>
  2994. DISTRO_FEATURES_BACKFILL[doc] = "Features to be added to DISTRO_FEATURES if not also present in DISTRO_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and it is not intended to be user-configurable."
  2995. </info>
  2996. <glossdef>
  2997. <para role="glossdeffirst">
  2998. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  2999. Features to be added to
  3000. <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>
  3001. if not also present in
  3002. <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>.
  3003. </para>
  3004. <para>
  3005. This variable is set in the <filename>meta/conf/bitbake.conf</filename> file.
  3006. It is not intended to be user-configurable.
  3007. It is best to just reference the variable to see which distro features are
  3008. being backfilled for all distro configurations.
  3009. See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for
  3010. more information.
  3011. </para>
  3012. </glossdef>
  3013. </glossentry>
  3014. <glossentry id='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><glossterm>DISTRO_FEATURES_BACKFILL_CONSIDERED</glossterm>
  3015. <info>
  3016. DISTRO_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from DISTRO_FEATURES_BACKFILL that should not be backfilled (i.e. added to DISTRO_FEATURES) during the build."
  3017. </info>
  3018. <glossdef>
  3019. <para role="glossdeffirst">
  3020. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3021. Features from
  3022. <filename><link linkend='var-DISTRO_FEATURES_BACKFILL'>DISTRO_FEATURES_BACKFILL</link></filename>
  3023. that should not be backfilled (i.e. added to
  3024. <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>)
  3025. during the build.
  3026. See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for
  3027. more information.
  3028. </para>
  3029. </glossdef>
  3030. </glossentry>
  3031. <glossentry id='var-DISTRO_FEATURES_DEFAULT'><glossterm>DISTRO_FEATURES_DEFAULT</glossterm>
  3032. <info>
  3033. DISTRO_FEATURES_DEFAULT[doc] = "Provides the default list of distro features with the exception of any libc-specific features."
  3034. </info>
  3035. <glossdef>
  3036. <para role="glossdeffirst">
  3037. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3038. A convenience variable that gives you the default
  3039. list of distro features with the exception of any
  3040. features specific to the C library
  3041. (<filename>libc</filename>).
  3042. </para>
  3043. <para>
  3044. When creating a custom distribution, you might find it
  3045. useful to be able to reuse the default
  3046. <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
  3047. options without the need to write out the full set.
  3048. Here is an example that uses
  3049. <filename>DISTRO_FEATURES_DEFAULT</filename> from a
  3050. custom distro configuration file:
  3051. <literallayout class='monospaced'>
  3052. DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${DISTRO_FEATURES_LIBC} myfeature"
  3053. </literallayout>
  3054. </para>
  3055. </glossdef>
  3056. </glossentry>
  3057. <glossentry id='var-DISTRO_FEATURES_LIBC'><glossterm>DISTRO_FEATURES_LIBC</glossterm>
  3058. <info>
  3059. DISTRO_FEATURES_LIBC[doc] = "Specifies the list of distro features that are specific to the C library (libc)."
  3060. </info>
  3061. <glossdef>
  3062. <para role="glossdeffirst">
  3063. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3064. A convenience variable that specifies the list of distro
  3065. features that are specific to the C library
  3066. (<filename>libc</filename>).
  3067. Typically, these features are prefixed with "libc-" and
  3068. control which features are enabled at during the build
  3069. within the C library itself.
  3070. </para>
  3071. </glossdef>
  3072. </glossentry>
  3073. <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm>
  3074. <info>
  3075. DISTRO_NAME[doc] = "The long name of the distribution."
  3076. </info>
  3077. <glossdef>
  3078. <para role="glossdeffirst">
  3079. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3080. The long name of the distribution.
  3081. </para>
  3082. </glossdef>
  3083. </glossentry>
  3084. <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm>
  3085. <info>
  3086. DISTRO_VERSION[doc] = "The version of the distribution."
  3087. </info>
  3088. <glossdef>
  3089. <para role="glossdeffirst">
  3090. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3091. The version of the distribution.
  3092. </para>
  3093. </glossdef>
  3094. </glossentry>
  3095. <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm>
  3096. <info>
  3097. DISTROOVERRIDES[doc] = "Lists overrides specific to the current distribution. By default, the variable list includes the value of the DISTRO variable."
  3098. </info>
  3099. <glossdef>
  3100. <para role="glossdeffirst">
  3101. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3102. This variable lists overrides specific to the current
  3103. distribution.
  3104. By default, the variable list includes the value of the
  3105. <filename><link linkend='var-DISTRO'>DISTRO</link></filename>
  3106. variable.
  3107. You can extend the variable to apply any variable overrides
  3108. you want as part of the distribution and are not
  3109. already in <filename>OVERRIDES</filename> through
  3110. some other means.
  3111. </para>
  3112. </glossdef>
  3113. </glossentry>
  3114. <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
  3115. <info>
  3116. DL_DIR[doc] = "The central download directory used by the build process to store downloads. By default, the directory is 'downloads' in the Build Directory."
  3117. </info>
  3118. <glossdef>
  3119. <para role="glossdeffirst">
  3120. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3121. The central download directory used by the build process to
  3122. store downloads.
  3123. By default, <filename>DL_DIR</filename> gets files
  3124. suitable for mirroring for everything except Git
  3125. repositories.
  3126. If you want tarballs of Git repositories, use the
  3127. <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link>
  3128. variable.
  3129. </para>
  3130. <para>
  3131. You can set this directory by defining the
  3132. <filename>DL_DIR</filename> variable in the
  3133. <filename>conf/local.conf</filename> file.
  3134. This directory is self-maintaining and you should not have
  3135. to touch it.
  3136. By default, the directory is <filename>downloads</filename>
  3137. in the
  3138. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  3139. <literallayout class='monospaced'>
  3140. #DL_DIR ?= "${TOPDIR}/downloads"
  3141. </literallayout>
  3142. To specify a different download directory, simply remove
  3143. the comment from the line and provide your directory.
  3144. </para>
  3145. <para>
  3146. During a first build, the system downloads many different
  3147. source code tarballs from various upstream projects.
  3148. Downloading can take a while, particularly if your network
  3149. connection is slow.
  3150. Tarballs are all stored in the directory defined by
  3151. <filename>DL_DIR</filename> and the build system looks there
  3152. first to find source tarballs.
  3153. <note>
  3154. When wiping and rebuilding, you can preserve this
  3155. directory to speed up this part of subsequent
  3156. builds.
  3157. </note>
  3158. </para>
  3159. <para>
  3160. You can safely share this directory between multiple builds
  3161. on the same development machine.
  3162. For additional information on how the build process gets
  3163. source files when working behind a firewall or proxy server,
  3164. see this specific question in the
  3165. "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>"
  3166. chapter.
  3167. You can also refer to the
  3168. "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>"
  3169. Wiki page.
  3170. </para>
  3171. </glossdef>
  3172. </glossentry>
  3173. <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm>
  3174. <info>
  3175. DOC_COMPRESS[doc] = "When inheriting the compress_doc class, this variable sets the compression policy used when the OpenEmbedded build system compresses man pages and info pages."
  3176. </info>
  3177. <glossdef>
  3178. <para role="glossdeffirst">
  3179. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3180. When inheriting the
  3181. <link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link>
  3182. class, this variable sets the compression policy used when
  3183. the OpenEmbedded build system compresses man pages and info
  3184. pages.
  3185. By default, the compression method used is gz (gzip).
  3186. Other policies available are xz and bz2.
  3187. </para>
  3188. <para>
  3189. For information on policies and on how to use this
  3190. variable, see the comments in the
  3191. <filename>meta/classes/compress_doc.bbclass</filename> file.
  3192. </para>
  3193. </glossdef>
  3194. </glossentry>
  3195. </glossdiv>
  3196. <glossdiv id='var-glossary-e'><title>E</title>
  3197. <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm>
  3198. <info>
  3199. EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg or vmdk is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use."
  3200. </info>
  3201. <glossdef>
  3202. <para role="glossdeffirst">
  3203. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3204. When building bootable images (i.e. where
  3205. <filename>hddimg</filename> or <filename>vmdk</filename>
  3206. is in
  3207. <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>),
  3208. the <filename>EFI_PROVIDER</filename> variable specifies
  3209. the EFI bootloader to use.
  3210. The default is "grub-efi", but "gummiboot" can be used
  3211. instead.
  3212. </para>
  3213. <para>
  3214. See the
  3215. <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
  3216. class for more information.
  3217. </para>
  3218. </glossdef>
  3219. </glossentry>
  3220. <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
  3221. <info>
  3222. ENABLE_BINARY_LOCALE_GENERATION[doc] = "Controls which locales for glibc are generated during the build. The variable is useful if the target device has 64Mbytes of RAM or less."
  3223. </info>
  3224. <glossdef>
  3225. <para role="glossdeffirst">
  3226. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3227. Variable that controls which locales for
  3228. <filename>glibc</filename> are generated during the
  3229. build (useful if the target device has 64Mbytes
  3230. of RAM or less).
  3231. </para>
  3232. </glossdef>
  3233. </glossentry>
  3234. <glossentry id='var-ERR_REPORT_DIR'><glossterm>ERR_REPORT_DIR</glossterm>
  3235. <info>
  3236. ERR_REPORT_DIR[doc] = "When used with the report-error class, specifies the path used for storing the debug files created by the error reporting tool, which allows you to submit build errors you encounter to a central database."
  3237. </info>
  3238. <glossdef>
  3239. <para role="glossdeffirst">
  3240. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3241. When used with the
  3242. <link linkend='ref-classes-report-error'><filename>report-error</filename></link>
  3243. class, specifies the path used for storing the debug files
  3244. created by the
  3245. <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>,
  3246. which allows you to submit build errors you encounter to a
  3247. central database.
  3248. By default, the value of this variable is
  3249. <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>.
  3250. </para>
  3251. <para>
  3252. You can set <filename>ERR_REPORT_DIR</filename> to the path
  3253. you want the error reporting tool to store the debug files
  3254. as follows in your <filename>local.conf</filename> file:
  3255. <literallayout class='monospaced'>
  3256. ERR_REPORT_DIR = "<replaceable>path</replaceable>"
  3257. </literallayout>
  3258. </para>
  3259. </glossdef>
  3260. </glossentry>
  3261. <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm>
  3262. <info>
  3263. ERROR_QA[doc] = "Specifies the quality assurance checks whose failures are reported as errors by the OpenEmbedded build system."
  3264. </info>
  3265. <glossdef>
  3266. <para role="glossdeffirst">
  3267. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3268. Specifies the quality assurance checks whose failures are
  3269. reported as errors by the OpenEmbedded build system.
  3270. You set this variable in your distribution configuration
  3271. file.
  3272. For a list of the checks you can control with this variable,
  3273. see the
  3274. "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
  3275. section.
  3276. </para>
  3277. </glossdef>
  3278. </glossentry>
  3279. <glossentry id='var-EXCLUDE_FROM_SHLIBS'><glossterm>EXCLUDE_FROM_SHLIBS</glossterm>
  3280. <info>
  3281. EXCLUDE_FROM_SHLIBS[doc] = "Causes the OpenEmbedded build system's shared libraries resolver to exclude an entire package when scanning for shared libraries."
  3282. </info>
  3283. <glossdef>
  3284. <para role="glossdeffirst">
  3285. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3286. Triggers the OpenEmbedded build system's shared libraries
  3287. resolver to exclude an entire package when scanning for
  3288. shared libraries.
  3289. <note>
  3290. The shared libraries resolver's functionality results
  3291. in part from the internal function
  3292. <filename>package_do_shlibs</filename>, which is part of
  3293. the
  3294. <link linkend='ref-tasks-package'><filename>do_package</filename></link>
  3295. task.
  3296. You should be aware that the shared libraries resolver
  3297. might implicitly define some dependencies between
  3298. packages.
  3299. </note>
  3300. The <filename>EXCLUDE_FROM_SHLIBS</filename> variable is
  3301. similar to the
  3302. <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link>
  3303. variable, which excludes a package's particular libraries
  3304. only and not the whole package.
  3305. </para>
  3306. <para>
  3307. Use the
  3308. <filename>EXCLUDE_FROM_SHLIBS</filename> variable by
  3309. setting it to "1" for a particular package:
  3310. <literallayout class='monospaced'>
  3311. EXCLUDE_FROM_SHLIBS = "1"
  3312. </literallayout>
  3313. </para>
  3314. </glossdef>
  3315. </glossentry>
  3316. <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
  3317. <info>
  3318. EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude a recipe from world builds (i.e. bitbake world)."
  3319. </info>
  3320. <glossdef>
  3321. <para role="glossdeffirst">
  3322. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3323. Directs BitBake to exclude a recipe from world builds (i.e.
  3324. <filename>bitbake world</filename>).
  3325. During world builds, BitBake locates, parses and builds all
  3326. recipes found in every layer exposed in the
  3327. <filename>bblayers.conf</filename> configuration file.
  3328. </para>
  3329. <para>
  3330. To exclude a recipe from a world build using this variable,
  3331. set the variable to "1" in the recipe.
  3332. </para>
  3333. <note>
  3334. Recipes added to <filename>EXCLUDE_FROM_WORLD</filename>
  3335. may still be built during a world build in order to satisfy
  3336. dependencies of other recipes.
  3337. Adding a recipe to <filename>EXCLUDE_FROM_WORLD</filename>
  3338. only ensures that the recipe is not explicitly added
  3339. to the list of build targets in a world build.
  3340. </note>
  3341. </glossdef>
  3342. </glossentry>
  3343. <glossentry id='var-EXTENDPE'><glossterm>EXTENDPE</glossterm>
  3344. <info>
  3345. EXTENDPE[doc] = "Used with file and pathnames to create a prefix for a recipe's version based on the recipe's PE value. If PE is set and greater than zero for a recipe, EXTENDPE becomes that value."
  3346. </info>
  3347. <glossdef>
  3348. <para role="glossdeffirst">
  3349. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3350. Used with file and pathnames to create a prefix for a recipe's
  3351. version based on the recipe's
  3352. <link linkend='var-PE'><filename>PE</filename></link> value.
  3353. If <filename>PE</filename> is set and greater than zero for a recipe,
  3354. <filename>EXTENDPE</filename> becomes that value (e.g if
  3355. <filename>PE</filename> is equal to "1" then <filename>EXTENDPE</filename>
  3356. becomes "1_").
  3357. If a recipe's <filename>PE</filename> is not set (the default) or is equal to
  3358. zero, <filename>EXTENDPE</filename> becomes "".</para>
  3359. <para>See the <link linkend='var-STAMP'><filename>STAMP</filename></link>
  3360. variable for an example.
  3361. </para>
  3362. </glossdef>
  3363. </glossentry>
  3364. <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm>
  3365. <info>
  3366. EXTENDPKGV[doc] = "The full package version specification as it appears on the final packages produced by a recipe."
  3367. </info>
  3368. <glossdef>
  3369. <para role="glossdeffirst">
  3370. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3371. The full package version specification as it appears on the
  3372. final packages produced by a recipe.
  3373. The variable's value is normally used to fix a runtime
  3374. dependency to the exact same version of another package
  3375. in the same recipe:
  3376. <literallayout class='monospaced'>
  3377. RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
  3378. </literallayout>
  3379. </para>
  3380. <para>
  3381. The dependency relationships are intended to force the
  3382. package manager to upgrade these types of packages in
  3383. lock-step.
  3384. </para>
  3385. </glossdef>
  3386. </glossentry>
  3387. <glossentry id='var-EXTERNAL_KERNEL_TOOLS'><glossterm>EXTERNAL_KERNEL_TOOLS</glossterm>
  3388. <info>
  3389. EXTERNAL_KERNEL_TOOLS[doc] = "Indicates kernel tools are external to the source tree."
  3390. </info>
  3391. <glossdef>
  3392. <para role="glossdeffirst">
  3393. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3394. When set, the <filename>EXTERNAL_KERNEL_TOOLS</filename>
  3395. variable indicates that these tools are not in the
  3396. source tree.
  3397. </para>
  3398. <para>
  3399. When kernel tools are available in the tree, they are
  3400. preferred over any externally installed tools.
  3401. Setting the <filename>EXTERNAL_KERNEL_TOOLS</filename>
  3402. variable tells the OpenEmbedded build system to prefer
  3403. the installed external tools.
  3404. See the
  3405. <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link>
  3406. class in <filename>meta/classes</filename> to see how
  3407. the variable is used.
  3408. </para>
  3409. </glossdef>
  3410. </glossentry>
  3411. <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
  3412. <info>
  3413. EXTERNALSRC[doc] = "If externalsrc.bbclass is inherited, this variable points to the source tree, which is outside of the OpenEmbedded build system."
  3414. </info>
  3415. <glossdef>
  3416. <para role="glossdeffirst">
  3417. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3418. When inheriting the
  3419. <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link>
  3420. class, this variable points to the source tree, which is
  3421. outside of the OpenEmbedded build system.
  3422. When set, this variable sets the
  3423. <link linkend='var-S'><filename>S</filename></link>
  3424. variable, which is what the OpenEmbedded build system uses
  3425. to locate unpacked recipe source code.
  3426. </para>
  3427. <para>
  3428. For more information on
  3429. <filename>externalsrc.bbclass</filename>, see the
  3430. "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>"
  3431. section.
  3432. You can also find information on how to use this variable
  3433. in the
  3434. "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
  3435. section in the Yocto Project Development Manual.
  3436. </para>
  3437. </glossdef>
  3438. </glossentry>
  3439. <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
  3440. <info>
  3441. EXTERNALSRC_BUILD[doc] = "If externalsrc.bbclass is inherited, this variable points to the directory in which the recipe's source code is built, which is outside of the OpenEmbedded build system."
  3442. </info>
  3443. <glossdef>
  3444. <para role="glossdeffirst">
  3445. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3446. When inheriting the
  3447. <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link>
  3448. class, this variable points to the directory in which the
  3449. recipe's source code is built, which is outside of the
  3450. OpenEmbedded build system.
  3451. When set, this variable sets the
  3452. <link linkend='var-B'><filename>B</filename></link>
  3453. variable, which is what the OpenEmbedded build system uses
  3454. to locate the Build Directory.
  3455. </para>
  3456. <para>
  3457. For more information on
  3458. <filename>externalsrc.bbclass</filename>, see the
  3459. "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>"
  3460. section.
  3461. You can also find information on how to use this variable
  3462. in the
  3463. "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
  3464. section in the Yocto Project Development Manual.
  3465. </para>
  3466. </glossdef>
  3467. </glossentry>
  3468. <glossentry id='var-EXTRA_AUTORECONF'><glossterm>EXTRA_AUTORECONF</glossterm>
  3469. <info>
  3470. EXTRA_AUTORECONF[doc] = "Extra options passed to the autoreconf command, which is executed during do_configure."
  3471. </info>
  3472. <glossdef>
  3473. <para role="glossdeffirst">
  3474. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3475. For recipes inheriting the
  3476. <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
  3477. class, you can use <filename>EXTRA_AUTORECONF</filename> to
  3478. specify extra options to pass to the
  3479. <filename>autoreconf</filename> command that is
  3480. executed during the
  3481. <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
  3482. task.
  3483. </para>
  3484. <para>
  3485. The default value is "--exclude=autopoint".
  3486. </para>
  3487. </glossdef>
  3488. </glossentry>
  3489. <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm>
  3490. <info>
  3491. EXTRA_IMAGE_FEATURES[doc] = "The list of additional features to include in an image. Configure this variable in the conf/local.conf file in the Build Directory."
  3492. </info>
  3493. <glossdef>
  3494. <para role="glossdeffirst">
  3495. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3496. A list of additional features to include in an image.
  3497. When listing more than one feature, separate them with
  3498. a space.
  3499. </para>
  3500. <para>
  3501. Typically, you configure this variable in your
  3502. <filename>local.conf</filename> file, which is found in the
  3503. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  3504. Although you can use this variable from within a recipe,
  3505. best practices dictate that you do not.
  3506. <note>
  3507. To enable primary features from within the image
  3508. recipe, use the
  3509. <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
  3510. variable.
  3511. </note>
  3512. </para>
  3513. <para>
  3514. Here are some examples of features you can add:
  3515. <literallayout class='monospaced'>
  3516. "dbg-pkgs" - Adds -dbg packages for all installed packages
  3517. including symbol information for debugging and
  3518. profiling.
  3519. "debug-tweaks" - Makes an image suitable for debugging.
  3520. For example, allows root logins without
  3521. passwords and enables post-installation
  3522. logging. See the 'allow-empty-password'
  3523. and 'post-install-logging' features in
  3524. the "<link linkend='ref-features-image'>Image Features</link>" section for
  3525. more information.
  3526. "dev-pkgs" - Adds -dev packages for all installed packages.
  3527. This is useful if you want to develop against
  3528. the libraries in the image.
  3529. "read-only-rootfs" - Creates an image whose root
  3530. filesystem is read-only. See the
  3531. "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
  3532. section in the Yocto Project
  3533. Development Manual for more
  3534. information
  3535. "tools-debug" - Adds debugging tools such as gdb and
  3536. strace.
  3537. "tools-sdk" - Adds development tools such as gcc, make,
  3538. pkgconfig and so forth.
  3539. "tools-testapps" - Adds useful testing tools such as
  3540. ts_print, aplay, arecord and so
  3541. forth.
  3542. </literallayout>
  3543. </para>
  3544. <para>
  3545. For a complete list of image features that ships with the
  3546. Yocto Project, see the
  3547. "<link linkend="ref-features-image">Image Features</link>"
  3548. section.
  3549. </para>
  3550. <para>
  3551. For an example that shows how to customize your image by
  3552. using this variable, see the
  3553. "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>"
  3554. section in the Yocto Project Development Manual.
  3555. </para>
  3556. </glossdef>
  3557. </glossentry>
  3558. <glossentry id='var-EXTRA_IMAGECMD'><glossterm>EXTRA_IMAGECMD</glossterm>
  3559. <info>
  3560. EXTRA_IMAGECMD[doc] = "Specifies additional options for the image creation command that has been specified in IMAGE_CMD. When setting this variable, you should use an override for the associated type."
  3561. </info>
  3562. <glossdef>
  3563. <para role="glossdeffirst">
  3564. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3565. Specifies additional options for the image
  3566. creation command that has been specified in
  3567. <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>.
  3568. When setting this variable, you should
  3569. use an override for the associated type.
  3570. Here is an example:
  3571. <literallayout class='monospaced'>
  3572. EXTRA_IMAGECMD_ext3 ?= "-i 4096"
  3573. </literallayout>
  3574. </para>
  3575. </glossdef>
  3576. </glossentry>
  3577. <glossentry id='var-EXTRA_IMAGEDEPENDS'><glossterm>EXTRA_IMAGEDEPENDS</glossterm>
  3578. <info>
  3579. EXTRA_IMAGEDEPENDS[doc] = "A list of recipes to build that do not provide packages for installing into the root filesystem. Use this variable to list recipes that are required to build the final image, but not needed in the root filesystem."
  3580. </info>
  3581. <glossdef>
  3582. <para role="glossdeffirst">
  3583. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3584. A list of recipes to build that do not provide packages
  3585. for installing into the root filesystem.
  3586. </para>
  3587. <para>
  3588. Sometimes a recipe is required to build the final image but is not
  3589. needed in the root filesystem.
  3590. You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to
  3591. list these recipes and thus specify the dependencies.
  3592. A typical example is a required bootloader in a machine configuration.
  3593. </para>
  3594. <note>
  3595. To add packages to the root filesystem, see the various
  3596. <filename>*<link linkend='var-RDEPENDS'>RDEPENDS</link></filename>
  3597. and <filename>*<link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></filename>
  3598. variables.
  3599. </note>
  3600. </glossdef>
  3601. </glossentry>
  3602. <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
  3603. <info>
  3604. EXTRA_OECMAKE[doc] = "Additional cmake options."
  3605. </info>
  3606. <glossdef>
  3607. <para role="glossdeffirst">
  3608. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3609. Additional <filename>cmake</filename> options.
  3610. </para>
  3611. </glossdef>
  3612. </glossentry>
  3613. <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm>
  3614. <info>
  3615. EXTRA_OECONF[doc] = "Additional configure script options."
  3616. </info>
  3617. <glossdef>
  3618. <para role="glossdeffirst">
  3619. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3620. Additional <filename>configure</filename> script options.
  3621. </para>
  3622. </glossdef>
  3623. </glossentry>
  3624. <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm>
  3625. <info>
  3626. EXTRA_OEMAKE[doc] = "Additional GNU make options."
  3627. </info>
  3628. <glossdef>
  3629. <para role="glossdeffirst">
  3630. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3631. Additional GNU <filename>make</filename> options.
  3632. </para>
  3633. <para>
  3634. Because the <filename>EXTRA_OEMAKE</filename> defaults to
  3635. "", you need to set the variable to specify any required
  3636. GNU options.
  3637. </para>
  3638. </glossdef>
  3639. </glossentry>
  3640. <glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm>
  3641. <info>
  3642. EXTRA_OESCONS[doc] = "When a recipe inherits the scons class, this variable specifies additional configuration options you want to pass to the scons command line."
  3643. </info>
  3644. <glossdef>
  3645. <para role="glossdeffirst">
  3646. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3647. When inheriting the
  3648. <link linkend='ref-classes-scons'><filename>scons</filename></link>
  3649. class, this variable specifies additional configuration
  3650. options you want to pass to the
  3651. <filename>scons</filename> command line.
  3652. </para>
  3653. </glossdef>
  3654. </glossentry>
  3655. <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm>
  3656. <info>
  3657. EXTRA_USERS_PARAMS[doc] = "When a recipe inherits the extrausers class, this variable provides image level user and group operations."
  3658. </info>
  3659. <glossdef>
  3660. <para role="glossdeffirst">
  3661. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3662. When inheriting the
  3663. <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link>
  3664. class, this variable provides image level user and group
  3665. operations.
  3666. This is a more global method of providing user and group
  3667. configuration as compared to using the
  3668. <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
  3669. class, which ties user and group configurations to a
  3670. specific recipe.
  3671. </para>
  3672. <para>
  3673. The set list of commands you can configure using the
  3674. <filename>EXTRA_USERS_PARAMS</filename> is shown in the
  3675. <filename>extrausers</filename> class.
  3676. These commands map to the normal Unix commands of the same
  3677. names:
  3678. <literallayout class='monospaced'>
  3679. # EXTRA_USERS_PARAMS = "\
  3680. # useradd -p '' tester; \
  3681. # groupadd developers; \
  3682. # userdel nobody; \
  3683. # groupdel -g video; \
  3684. # groupmod -g 1020 developers; \
  3685. # usermod -s /bin/sh tester; \
  3686. # "
  3687. </literallayout>
  3688. </para>
  3689. </glossdef>
  3690. </glossentry>
  3691. </glossdiv>
  3692. <glossdiv id='var-glossary-f'><title>F</title>
  3693. <glossentry id='var-FEATURE_PACKAGES'><glossterm>FEATURE_PACKAGES</glossterm>
  3694. <info>
  3695. FEATURE_PACKAGES[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES. When setting the value, FEATURE_PACKAGES should have the name of the feature item as an override."
  3696. </info>
  3697. <glossdef>
  3698. <para role="glossdeffirst">
  3699. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3700. Defines one or more packages to include in an image when
  3701. a specific item is included in
  3702. <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
  3703. When setting the value, <filename>FEATURE_PACKAGES</filename>
  3704. should have the name of the feature item as an override.
  3705. Here is an example:
  3706. <literallayout class='monospaced'>
  3707. FEATURE_PACKAGES_widget = "<replaceable>package1</replaceable> <replaceable>package2</replaceable>"
  3708. </literallayout>
  3709. </para>
  3710. <para>
  3711. In this example, if "widget" were added to
  3712. <filename>IMAGE_FEATURES</filename>, <replaceable>package1</replaceable> and
  3713. <replaceable>package2</replaceable> would be included in the image.
  3714. <note>
  3715. Packages installed by features defined through
  3716. <filename>FEATURE_PACKAGES</filename> are often package
  3717. groups.
  3718. While similarly named, you should not confuse the
  3719. <filename>FEATURE_PACKAGES</filename> variable with
  3720. package groups, which are discussed elsewhere in the
  3721. documentation.
  3722. </note>
  3723. </para>
  3724. </glossdef>
  3725. </glossentry>
  3726. <glossentry id='var-FEED_DEPLOYDIR_BASE_URI'><glossterm>FEED_DEPLOYDIR_BASE_URI</glossterm>
  3727. <info>
  3728. FEED_DEPLOYDIR_BASE_URI[doc] = "Allow to serve ipk deploy directory as an ad hoc feed (bogofeed). Set to base URL of the directory as exported by HTTP. Set of ad hoc feed configs will be generated in the image."
  3729. </info>
  3730. <glossdef>
  3731. <para role="glossdeffirst">
  3732. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3733. Points to the base URL of the server and location within
  3734. the document-root that provides the metadata and
  3735. packages required by OPKG to support runtime package
  3736. management of IPK packages.
  3737. You set this variable in your
  3738. <filename>local.conf</filename> file.
  3739. </para>
  3740. <para>
  3741. Consider the following example:
  3742. <literallayout class='monospaced'>
  3743. FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir"
  3744. </literallayout>
  3745. This example assumes you are serving your packages over
  3746. HTTP and your databases are located in a directory
  3747. named <filename>BOARD-dir</filename>, which is underneath
  3748. your HTTP server's document-root.
  3749. In this case, the OpenEmbedded build system generates a set
  3750. of configuration files for you in your target that work
  3751. with the feed.
  3752. </para>
  3753. </glossdef>
  3754. </glossentry>
  3755. <glossentry id='var-FILES'><glossterm>FILES</glossterm>
  3756. <info>
  3757. FILES[doc] = "The list of directories or files that are placed in packages."
  3758. </info>
  3759. <glossdef>
  3760. <para role="glossdeffirst">
  3761. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3762. The list of directories or files that are placed in packages.
  3763. </para>
  3764. <para>
  3765. To use the <filename>FILES</filename> variable, provide a
  3766. package name override that identifies the resulting package.
  3767. Then, provide a space-separated list of files or paths
  3768. that identify the files you want included as part of the
  3769. resulting package.
  3770. Here is an example:
  3771. <literallayout class='monospaced'>
  3772. FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile"
  3773. </literallayout>
  3774. </para>
  3775. <note>
  3776. When specifying paths as part of the
  3777. <filename>FILES</filename> variable, it is good practice
  3778. to use appropriate path variables.
  3779. For example, use <filename>${sysconfdir}</filename> rather
  3780. than <filename>/etc</filename>, or
  3781. <filename>${bindir}</filename> rather than
  3782. <filename>/usr/bin</filename>.
  3783. You can find a list of these variables at the top of the
  3784. <filename>meta/conf/bitbake.conf</filename> file in the
  3785. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  3786. </note>
  3787. <para>
  3788. If some of the files you provide with the
  3789. <filename>FILES</filename> variable are editable and you
  3790. know they should not be overwritten during the package
  3791. update process by the Package Management System (PMS), you
  3792. can identify these files so that the PMS will not
  3793. overwrite them.
  3794. See the
  3795. <link linkend='var-CONFFILES'><filename>CONFFILES</filename></link>
  3796. variable for information on how to identify these files to
  3797. the PMS.
  3798. </para>
  3799. </glossdef>
  3800. </glossentry>
  3801. <glossentry id='var-FILES_SOLIBSDEV'><glossterm>FILES_SOLIBSDEV</glossterm>
  3802. <info>
  3803. FILES_SOLIBSDEV[doc] = "Defines the full path name of the development symbolic link (symlink) for shared libraries on the target platform."
  3804. </info>
  3805. <glossdef>
  3806. <para role="glossdeffirst">
  3807. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3808. Defines the file specification to match
  3809. <link linkend='var-SOLIBSDEV'><filename>SOLIBSDEV</filename></link>.
  3810. In other words, <filename>FILES_SOLIBSDEV</filename>
  3811. defines the full path name of the development symbolic link
  3812. (symlink) for shared libraries on the target platform.
  3813. </para>
  3814. <para>
  3815. The following statement from the
  3816. <filename>bitbake.conf</filename> shows how it is set:
  3817. <literallayout class='monospaced'>
  3818. FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}"
  3819. </literallayout>
  3820. </para>
  3821. </glossdef>
  3822. </glossentry>
  3823. <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm>
  3824. <info>
  3825. FILESEXTRAPATHS[doc] = "Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files."
  3826. </info>
  3827. <glossdef>
  3828. <para role="glossdeffirst">
  3829. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3830. Extends the search path the OpenEmbedded build system uses
  3831. when looking for files and patches as it processes recipes
  3832. and append files.
  3833. The default directories BitBake uses when it processes
  3834. recipes are initially defined by the
  3835. <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
  3836. variable.
  3837. You can extend <filename>FILESPATH</filename> variable
  3838. by using <filename>FILESEXTRAPATHS</filename>.
  3839. </para>
  3840. <para>
  3841. Best practices dictate that you accomplish this by using
  3842. <filename>FILESEXTRAPATHS</filename> from within a
  3843. <filename>.bbappend</filename> file and that you prepend
  3844. paths as follows:
  3845. <literallayout class='monospaced'>
  3846. FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
  3847. </literallayout>
  3848. In the above example, the build system first looks for files
  3849. in a directory that has the same name as the corresponding
  3850. append file.
  3851. <note>
  3852. <para>When extending <filename>FILESEXTRAPATHS</filename>,
  3853. be sure to use the immediate expansion
  3854. (<filename>:=</filename>) operator.
  3855. Immediate expansion makes sure that BitBake evaluates
  3856. <link linkend='var-THISDIR'><filename>THISDIR</filename></link>
  3857. at the time the directive is encountered rather than at
  3858. some later time when expansion might result in a
  3859. directory that does not contain the files you need.
  3860. </para>
  3861. <para>Also, include the trailing separating colon
  3862. character if you are prepending.
  3863. The trailing colon character is necessary because you
  3864. are directing BitBake to extend the path by prepending
  3865. directories to the search path.</para>
  3866. </note>
  3867. Here is another common use:
  3868. <literallayout class='monospaced'>
  3869. FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
  3870. </literallayout>
  3871. In this example, the build system extends the
  3872. <filename>FILESPATH</filename> variable to include a
  3873. directory named <filename>files</filename> that is in the
  3874. same directory as the corresponding append file.
  3875. </para>
  3876. <para>
  3877. Here is a final example that specifically adds three paths:
  3878. <literallayout class='monospaced'>
  3879. FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
  3880. </literallayout>
  3881. </para>
  3882. <para>
  3883. By prepending paths in <filename>.bbappend</filename>
  3884. files, you allow multiple append files that reside in
  3885. different layers but are used for the same recipe to
  3886. correctly extend the path.
  3887. </para>
  3888. </glossdef>
  3889. </glossentry>
  3890. <glossentry id='var-FILESOVERRIDES'><glossterm>FILESOVERRIDES</glossterm>
  3891. <info>
  3892. FILESOVERRIDES[doc] = "A subset of OVERRIDES used by the OpenEmbedded build system for creating FILESPATH."
  3893. </info>
  3894. <glossdef>
  3895. <para role="glossdeffirst">
  3896. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3897. A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
  3898. used by the OpenEmbedded build system for creating
  3899. <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
  3900. You can find more information on how overrides are handled
  3901. in the
  3902. <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake Manual</ulink>.
  3903. </para>
  3904. <para>
  3905. By default, the <filename>FILESOVERRIDES</filename>
  3906. variable is defined as:
  3907. <literallayout class='monospaced'>
  3908. FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}"
  3909. </literallayout>
  3910. <note>
  3911. Do not hand-edit the <filename>FILESOVERRIDES</filename>
  3912. variable.
  3913. The values match up with expected overrides and are
  3914. used in an expected manner by the build system.
  3915. </note>
  3916. </para>
  3917. </glossdef>
  3918. </glossentry>
  3919. <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
  3920. <info>
  3921. FILESPATH[doc] = "The default set of directories the OpenEmbedded build system uses when searching for patches and files. It is defined in the base.bbclass class found in meta/classes in the Source Directory. Do not hand-edit the FILESPATH variable."
  3922. </info>
  3923. <glossdef>
  3924. <para role="glossdeffirst">
  3925. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3926. The default set of directories the OpenEmbedded build system
  3927. uses when searching for patches and files.
  3928. During the build process, BitBake searches each directory in
  3929. <filename>FILESPATH</filename> in the specified order when
  3930. looking for files and patches specified by each
  3931. <filename>file://</filename> URI in a recipe.
  3932. </para>
  3933. <para>
  3934. The default value for the <filename>FILESPATH</filename>
  3935. variable is defined in the <filename>base.bbclass</filename>
  3936. class found in <filename>meta/classes</filename> in the
  3937. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
  3938. <literallayout class='monospaced'>
  3939. FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
  3940. "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
  3941. </literallayout>
  3942. <note>
  3943. Do not hand-edit the <filename>FILESPATH</filename>
  3944. variable.
  3945. If you want the build system to look in directories
  3946. other than the defaults, extend the
  3947. <filename>FILESPATH</filename> variable by using the
  3948. <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
  3949. variable.
  3950. </note>
  3951. Be aware that the default <filename>FILESPATH</filename>
  3952. directories do not map to directories in custom layers
  3953. where append files (<filename>.bbappend</filename>)
  3954. are used.
  3955. If you want the build system to find patches or files
  3956. that reside with your append files, you need to extend
  3957. the <filename>FILESPATH</filename> variable by using
  3958. the
  3959. <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
  3960. variable.
  3961. </para>
  3962. </glossdef>
  3963. </glossentry>
  3964. <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm>
  3965. <info>
  3966. FILESYSTEM_PERMS_TABLES[doc] = "Allows you to define your own file permissions settings table as part of your configuration for the packaging process."
  3967. </info>
  3968. <glossdef>
  3969. <para role="glossdeffirst">
  3970. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  3971. Allows you to define your own file permissions settings table as part of
  3972. your configuration for the packaging process.
  3973. For example, suppose you need a consistent set of custom permissions for
  3974. a set of groups and users across an entire work project.
  3975. It is best to do this in the packages themselves but this is not always
  3976. possible.
  3977. </para>
  3978. <para>
  3979. By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which
  3980. is located in the <filename>meta/files</filename> folder in the
  3981. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  3982. If you create your own file permissions setting table, you should place it in your
  3983. layer or the distro's layer.
  3984. </para>
  3985. <para>
  3986. You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
  3987. <filename>conf/local.conf</filename> file, which is found in the
  3988. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to
  3989. point to your custom <filename>fs-perms.txt</filename>.
  3990. You can specify more than a single file permissions setting table.
  3991. The paths you specify to these files must be defined within the
  3992. <link linkend='var-BBPATH'><filename>BBPATH</filename></link> variable.
  3993. </para>
  3994. <para>
  3995. For guidance on how to create your own file permissions settings table file,
  3996. examine the existing <filename>fs-perms.txt</filename>.
  3997. </para>
  3998. </glossdef>
  3999. </glossentry>
  4000. <glossentry id='var-FONT_EXTRA_RDEPENDS'><glossterm>FONT_EXTRA_RDEPENDS</glossterm>
  4001. <info>
  4002. FONT_EXTRA_RDEPENDS[doc] = "When a recipe inherits the fontcache class, this variable specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'."
  4003. </info>
  4004. <glossdef>
  4005. <para role="glossdeffirst">
  4006. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4007. When inheriting the
  4008. <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link>
  4009. class, this variable specifies the runtime dependencies
  4010. for font packages.
  4011. By default, the <filename>FONT_EXTRA_RDEPENDS</filename>
  4012. is set to "fontconfig-utils".
  4013. </para>
  4014. </glossdef>
  4015. </glossentry>
  4016. <glossentry id='var-FONT_PACKAGES'><glossterm>FONT_PACKAGES</glossterm>
  4017. <info>
  4018. FONT_PACKAGES[doc] = "When a recipe inherits the fontcache class, this variable identifies packages containing font files that need to be cached by Fontconfig."
  4019. </info>
  4020. <glossdef>
  4021. <para role="glossdeffirst">
  4022. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4023. When inheriting the
  4024. <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link>
  4025. class, this variable identifies packages containing font
  4026. files that need to be cached by Fontconfig.
  4027. By default, the <filename>fontcache</filename> class assumes
  4028. that fonts are in the recipe's main package
  4029. (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
  4030. Use this variable if fonts you need are in a package
  4031. other than that main package.
  4032. </para>
  4033. </glossdef>
  4034. </glossentry>
  4035. <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm>
  4036. <info>
  4037. FULL_OPTIMIZATION[doc]= "The options to pass in TARGET_CFLAGS and CFLAGS when compiling an optimized system. This variable defaults to '-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2'."
  4038. </info>
  4039. <glossdef>
  4040. <para role="glossdeffirst">
  4041. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4042. The options to pass in
  4043. <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
  4044. and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>
  4045. when compiling an optimized system.
  4046. This variable defaults to
  4047. "-O2 -pipe ${DEBUG_FLAGS}".
  4048. </para>
  4049. </glossdef>
  4050. </glossentry>
  4051. </glossdiv>
  4052. <glossdiv id='var-glossary-g'><title>G</title>
  4053. <glossentry id='var-GDB'><glossterm>GDB</glossterm>
  4054. <info>
  4055. GDB[doc] = "The minimal command and arguments to run the GNU Debugger."
  4056. </info>
  4057. <glossdef>
  4058. <para role="glossdeffirst">
  4059. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4060. The minimal command and arguments to run the GNU Debugger.
  4061. </para>
  4062. </glossdef>
  4063. </glossentry>
  4064. <glossentry id='var-GITDIR'><glossterm>GITDIR</glossterm>
  4065. <info>
  4066. GITDIR[doc] = "The directory where Git clones will be stored."
  4067. </info>
  4068. <glossdef>
  4069. <para role="glossdeffirst">
  4070. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4071. The directory in which a local copy of a Git repository
  4072. is stored when it is cloned.
  4073. </para>
  4074. </glossdef>
  4075. </glossentry>
  4076. <glossentry id='var-GLIBC_GENERATE_LOCALES'><glossterm>GLIBC_GENERATE_LOCALES</glossterm>
  4077. <info>
  4078. GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish generate all LIBC locals, which can be time consuming."
  4079. </info>
  4080. <glossdef>
  4081. <para role="glossdeffirst">
  4082. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4083. Specifies the list of GLIBC locales to generate should you
  4084. not wish generate all LIBC locals, which can be time
  4085. consuming.
  4086. <note>
  4087. If you specifically remove the locale
  4088. <filename>en_US.UTF-8</filename>, you must set
  4089. <link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link>
  4090. appropriately.
  4091. </note>
  4092. </para>
  4093. <para>
  4094. You can set <filename>GLIBC_GENERATE_LOCALES</filename>
  4095. in your <filename>local.conf</filename> file.
  4096. By default, all locales are generated.
  4097. <literallayout class='monospaced'>
  4098. GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8"
  4099. </literallayout>
  4100. </para>
  4101. </glossdef>
  4102. </glossentry>
  4103. <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm>
  4104. <info>
  4105. GROUPADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupadd command if you wish to add a group to the system when the package is installed."
  4106. </info>
  4107. <glossdef>
  4108. <para role="glossdeffirst">
  4109. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4110. When inheriting the
  4111. <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
  4112. class, this variable
  4113. specifies for a package what parameters should be passed
  4114. to the <filename>groupadd</filename> command
  4115. if you wish to add a group to the system when the package
  4116. is installed.
  4117. </para>
  4118. <para>
  4119. Here is an example from the <filename>dbus</filename>
  4120. recipe:
  4121. <literallayout class='monospaced'>
  4122. GROUPADD_PARAM_${PN} = "-r netdev"
  4123. </literallayout>
  4124. For information on the standard Linux shell command
  4125. <filename>groupadd</filename>, see
  4126. <ulink url='http://linux.die.net/man/8/groupadd'></ulink>.
  4127. </para>
  4128. </glossdef>
  4129. </glossentry>
  4130. <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm>
  4131. <info>
  4132. GROUPMEMS_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupmems command if you wish to modify the members of a group when the package is installed."
  4133. </info>
  4134. <glossdef>
  4135. <para role="glossdeffirst">
  4136. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4137. When inheriting the
  4138. <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
  4139. class, this variable
  4140. specifies for a package what parameters should be passed
  4141. to the <filename>groupmems</filename> command
  4142. if you wish to modify the members of a group when the
  4143. package is installed.
  4144. </para>
  4145. <para>
  4146. For information on the standard Linux shell command
  4147. <filename>groupmems</filename>, see
  4148. <ulink url='http://linux.die.net/man/8/groupmems'></ulink>.
  4149. </para>
  4150. </glossdef>
  4151. </glossentry>
  4152. <glossentry id='var-GRUB_GFXSERIAL'><glossterm>GRUB_GFXSERIAL</glossterm>
  4153. <info>
  4154. GRUB_GFXSERIAL[doc] = "Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and serial in the boot menu."
  4155. </info>
  4156. <glossdef>
  4157. <para role="glossdeffirst">
  4158. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4159. Configures the GNU GRand Unified Bootloader (GRUB) to have
  4160. graphics and serial in the boot menu.
  4161. Set this variable to "1" in your
  4162. <filename>local.conf</filename> or distribution
  4163. configuration file to enable graphics and serial
  4164. in the menu.
  4165. </para>
  4166. <para>
  4167. See the
  4168. <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link>
  4169. class for more information on how this variable is used.
  4170. </para>
  4171. </glossdef>
  4172. </glossentry>
  4173. <glossentry id='var-GRUB_OPTS'><glossterm>GRUB_OPTS</glossterm>
  4174. <info>
  4175. GRUB_OPTS[doc] = "Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuration."
  4176. </info>
  4177. <glossdef>
  4178. <para role="glossdeffirst">
  4179. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4180. Additional options to add to the GNU GRand Unified
  4181. Bootloader (GRUB) configuration.
  4182. Use a semi-colon character (<filename>;</filename>) to
  4183. separate multiple options.
  4184. </para>
  4185. <para>
  4186. The <filename>GRUB_OPTS</filename> variable is optional.
  4187. See the
  4188. <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link>
  4189. class for more information on how this variable is used.
  4190. </para>
  4191. </glossdef>
  4192. </glossentry>
  4193. <glossentry id='var-GRUB_TIMEOUT'><glossterm>GRUB_TIMEOUT</glossterm>
  4194. <info>
  4195. GRUB_TIMEOUT[doc] = "Specifies the timeout before executing the default LABEL in the GNU GRand Unified Bootloader (GRUB)."
  4196. </info>
  4197. <glossdef>
  4198. <para role="glossdeffirst">
  4199. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4200. Specifies the timeout before executing the default
  4201. <filename>LABEL</filename> in the GNU GRand Unified
  4202. Bootloader (GRUB).
  4203. </para>
  4204. <para>
  4205. The <filename>GRUB_TIMEOUT</filename> variable is optional.
  4206. See the
  4207. <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link>
  4208. class for more information on how this variable is used.
  4209. </para>
  4210. </glossdef>
  4211. </glossentry>
  4212. <glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm>
  4213. <info>
  4214. GTKIMMODULES_PACKAGES[doc] = "For recipes that inherit the gtk-immodules-cache class, this variable specifies the packages that contain the GTK+ input method modules being installed when the modules are in packages other than the main package."
  4215. </info>
  4216. <glossdef>
  4217. <para role="glossdeffirst">
  4218. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4219. When inheriting the
  4220. <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link>
  4221. class, this variable specifies the packages that contain the
  4222. GTK+ input method modules being installed when the modules
  4223. are in packages other than the main package.
  4224. </para>
  4225. </glossdef>
  4226. </glossentry>
  4227. <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm>
  4228. <info>
  4229. GUMMIBOOT_CFG[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_CFG variable specifies the configuration file that should be used."
  4230. </info>
  4231. <glossdef>
  4232. <para role="glossdeffirst">
  4233. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4234. When
  4235. <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
  4236. is set to "gummiboot", the
  4237. <filename>GUMMIBOOT_CFG</filename> variable specifies the
  4238. configuration file that should be used.
  4239. By default, the
  4240. <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
  4241. class sets the <filename>GUMMIBOOT_CFG</filename> as
  4242. follows:
  4243. <literallayout class='monospaced'>
  4244. GUMMIBOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf"
  4245. </literallayout>
  4246. </para>
  4247. <para>
  4248. For information on Gummiboot, see the
  4249. <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
  4250. </para>
  4251. </glossdef>
  4252. </glossentry>
  4253. <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm>
  4254. <info>
  4255. GUMMIBOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file."
  4256. </info>
  4257. <glossdef>
  4258. <para role="glossdeffirst">
  4259. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4260. When
  4261. <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
  4262. is set to "gummiboot", the
  4263. <filename>GUMMIBOOT_ENTRIES</filename> variable specifies
  4264. a list of entry files
  4265. (<filename>*.conf</filename>) to be installed
  4266. containing one boot entry per file.
  4267. By default, the
  4268. <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
  4269. class sets the <filename>GUMMIBOOT_ENTRIES</filename> as
  4270. follows:
  4271. <literallayout class='monospaced'>
  4272. GUMMIBOOT_ENTRIES ?= ""
  4273. </literallayout>
  4274. </para>
  4275. <para>
  4276. For information on Gummiboot, see the
  4277. <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
  4278. </para>
  4279. </glossdef>
  4280. </glossentry>
  4281. <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm>
  4282. <info>
  4283. GUMMIBOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_TIMEOUT variable specifies the boot menu timeout in seconds."
  4284. </info>
  4285. <glossdef>
  4286. <para role="glossdeffirst">
  4287. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4288. When
  4289. <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
  4290. is set to "gummiboot", the
  4291. <filename>GUMMIBOOT_TIMEOUT</filename> variable specifies
  4292. the boot menu timeout in seconds.
  4293. By default, the
  4294. <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
  4295. class sets the <filename>GUMMIBOOT_TIMEOUT</filename> as
  4296. follows:
  4297. <literallayout class='monospaced'>
  4298. GUMMIBOOT_TIMEOUT ?= "10"
  4299. </literallayout>
  4300. </para>
  4301. <para>
  4302. For information on Gummiboot, see the
  4303. <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
  4304. </para>
  4305. </glossdef>
  4306. </glossentry>
  4307. </glossdiv>
  4308. <glossdiv id='var-glossary-h'><title>H</title>
  4309. <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm>
  4310. <info>
  4311. HOMEPAGE[doc] = "Website where more information about the software the recipe is building can be found."
  4312. </info>
  4313. <glossdef>
  4314. <para role="glossdeffirst">
  4315. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4316. Website where more information about the software the recipe is building
  4317. can be found.
  4318. </para>
  4319. </glossdef>
  4320. </glossentry>
  4321. <glossentry id='var-HOST_ARCH'><glossterm>HOST_ARCH</glossterm>
  4322. <info>
  4323. HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH."
  4324. </info>
  4325. <glossdef>
  4326. <para role="glossdeffirst">
  4327. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4328. The name of the target architecture, which is normally
  4329. the same as
  4330. <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>.
  4331. The OpenEmbedded build system supports many
  4332. architectures.
  4333. Here is an example list of architectures supported.
  4334. This list is by no means complete as the architecture
  4335. is configurable:
  4336. <literallayout class='monospaced'>
  4337. arm
  4338. i586
  4339. x86_64
  4340. powerpc
  4341. powerpc64
  4342. mips
  4343. mipsel
  4344. </literallayout>
  4345. </para>
  4346. </glossdef>
  4347. </glossentry>
  4348. <glossentry id='var-HOST_CC_ARCH'><glossterm>HOST_CC_ARCH</glossterm>
  4349. <info>
  4350. HOST_CC_ARCH[doc] = "The name of the host architecture. Normally same as the TARGET_CC_ARCH."
  4351. </info>
  4352. <glossdef>
  4353. <para role="glossdeffirst">
  4354. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4355. Specifies architecture-specific compiler flags that are
  4356. passed to the C compiler.
  4357. </para>
  4358. <para>
  4359. Default initialization for <filename>HOST_CC_ARCH</filename>
  4360. varies depending on what is being built:
  4361. <itemizedlist>
  4362. <listitem><para>
  4363. <link linkend='var-TARGET_CC_ARCH'><filename>TARGET_CC_ARCH</filename></link>
  4364. when building for the target
  4365. </para></listitem>
  4366. <listitem><para>
  4367. <filename>BUILD_CC_ARCH</filename>
  4368. when building for the build host (i.e.
  4369. <filename>-native</filename>)
  4370. </para></listitem>
  4371. <listitem><para>
  4372. <filename>BUILDSDK_CC_ARCH</filename>
  4373. when building for an SDK (i.e.
  4374. <filename>nativesdk-</filename>)
  4375. </para></listitem>
  4376. </itemizedlist>
  4377. </para>
  4378. </glossdef>
  4379. </glossentry>
  4380. <glossentry id='var-HOST_OS'><glossterm>HOST_OS</glossterm>
  4381. <info>
  4382. HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS."
  4383. </info>
  4384. <glossdef>
  4385. <para role="glossdeffirst">
  4386. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4387. Specifies the name of the target operating system, which
  4388. is normally the same as the
  4389. <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>.
  4390. The variable can be set to "linux" for <filename>glibc</filename>-based systems and
  4391. to "linux-uclibc" for <filename>uclibc</filename>.
  4392. For ARM/EABI targets, there are also "linux-gnueabi" and
  4393. "linux-uclibc-gnueabi" values possible.
  4394. </para>
  4395. </glossdef>
  4396. </glossentry>
  4397. <glossentry id='var-HOST_PREFIX'><glossterm>HOST_PREFIX</glossterm>
  4398. <info>
  4399. HOST_PREFIX[doc] = "The prefix for the cross compile toolchain. Normally same as the TARGET_PREFIX."
  4400. </info>
  4401. <glossdef>
  4402. <para role="glossdeffirst">
  4403. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4404. Specifies the prefix for the cross-compile toolchain.
  4405. <filename>HOST_PREFIX</filename> is normally the same as
  4406. <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>.
  4407. </para>
  4408. </glossdef>
  4409. </glossentry>
  4410. <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm>
  4411. <info>
  4412. HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for with the build is occurring in the context of the current recipe."
  4413. </info>
  4414. <glossdef>
  4415. <para role="glossdeffirst">
  4416. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4417. Specifies the system, including the architecture and the
  4418. operating system, for which the build is occurring
  4419. in the context of the current recipe.
  4420. </para>
  4421. <para>
  4422. The OpenEmbedded build system automatically sets this
  4423. variable based on
  4424. <link linkend='var-HOST_ARCH'><filename>HOST_ARCH</filename></link>,
  4425. <link linkend='var-HOST_VENDOR'><filename>HOST_VENDOR</filename></link>,
  4426. and
  4427. <link linkend='var-HOST_OS'><filename>HOST_OS</filename></link>
  4428. variables.
  4429. <note>
  4430. You do not need to set the variable yourself.
  4431. </note>
  4432. </para>
  4433. <para>
  4434. Consider these two examples:
  4435. <itemizedlist>
  4436. <listitem><para>Given a native recipe on a 32-bit
  4437. x86 machine running Linux, the value is
  4438. "i686-linux".
  4439. </para></listitem>
  4440. <listitem><para>Given a recipe being built for a
  4441. little-endian MIPS target running Linux,
  4442. the value might be "mipsel-linux".
  4443. </para></listitem>
  4444. </itemizedlist>
  4445. </para>
  4446. </glossdef>
  4447. </glossentry>
  4448. <glossentry id='var-HOST_VENDOR'><glossterm>HOST_VENDOR</glossterm>
  4449. <info>
  4450. HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR."
  4451. </info>
  4452. <glossdef>
  4453. <para role="glossdeffirst">
  4454. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4455. Specifies the name of the vendor.
  4456. <filename>HOST_VENDOR</filename> is normally the same as
  4457. <link linkend='var-TARGET_PREFIX'><filename>TARGET_VENDOR</filename></link>.
  4458. </para>
  4459. </glossdef>
  4460. </glossentry>
  4461. </glossdiv>
  4462. <glossdiv id='var-glossary-i'><title>I</title>
  4463. <glossentry id='var-ICECC_DISABLED'><glossterm>ICECC_DISABLED</glossterm>
  4464. <info>
  4465. ICECC_DISABLED[doc] = "Disables or enables the icecc (Icecream) function."
  4466. </info>
  4467. <glossdef>
  4468. <para role="glossdeffirst">
  4469. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4470. Disables or enables the <filename>icecc</filename>
  4471. (Icecream) function.
  4472. For more information on this function and best practices
  4473. for using this variable, see the
  4474. "<link linkend='ref-classes-icecc'><filename>icecc.bbclass</filename></link>"
  4475. section.
  4476. </para>
  4477. <para>
  4478. Setting this variable to "1" in your
  4479. <filename>local.conf</filename> disables the function:
  4480. <literallayout class='monospaced'>
  4481. ICECC_DISABLED ??= "1"
  4482. </literallayout>
  4483. To enable the function, set the variable as follows:
  4484. <literallayout class='monospaced'>
  4485. ICECC_DISABLED = ""
  4486. </literallayout>
  4487. </para>
  4488. </glossdef>
  4489. </glossentry>
  4490. <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm>
  4491. <info>
  4492. ICECC_ENV_EXEC[doc] = "Points to the icecc-create-env script that you provide."
  4493. </info>
  4494. <glossdef>
  4495. <para role="glossdeffirst">
  4496. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4497. Points to the <filename>icecc-create-env</filename> script
  4498. that you provide.
  4499. This variable is used by the
  4500. <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
  4501. class.
  4502. You set this variable in your
  4503. <filename>local.conf</filename> file.
  4504. </para>
  4505. <para>
  4506. If you do not point to a script that you provide, the
  4507. OpenEmbedded build system uses the default script provided
  4508. by the <filename>icecc-create-env.bb</filename> recipe,
  4509. which is a modified version and not the one that comes with
  4510. <filename>icecc</filename>.
  4511. </para>
  4512. </glossdef>
  4513. </glossentry>
  4514. <glossentry id='var-ICECC_PARALLEL_MAKE'><glossterm>ICECC_PARALLEL_MAKE</glossterm>
  4515. <info>
  4516. ICECC_PARALLEL_MAKE[doc] = "Extra options passed to the make command during the do_compile task that specify parallel compilation."
  4517. </info>
  4518. <glossdef>
  4519. <para role="glossdeffirst">
  4520. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4521. Extra options passed to the <filename>make</filename>
  4522. command during the
  4523. <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>
  4524. task that specify parallel compilation.
  4525. This variable usually takes the form of
  4526. "-j <replaceable>x</replaceable>", where
  4527. <replaceable>x</replaceable> represents the maximum
  4528. number of parallel threads <filename>make</filename> can
  4529. run.
  4530. <note>
  4531. The options passed affect builds on all enabled
  4532. machines on the network, which are machines running the
  4533. <filename>iceccd</filename> daemon.
  4534. </note>
  4535. </para>
  4536. <para>
  4537. If your enabled machines support multiple cores,
  4538. coming up with the maximum number of parallel threads
  4539. that gives you the best performance could take some
  4540. experimentation since machine speed, network lag,
  4541. available memory, and existing machine loads can all
  4542. affect build time.
  4543. Consequently, unlike the
  4544. <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>
  4545. variable, there is no rule-of-thumb for setting
  4546. <filename>ICECC_PARALLEL_MAKE</filename> to achieve
  4547. optimal performance.
  4548. </para>
  4549. <para>
  4550. If you do not set <filename>ICECC_PARALLEL_MAKE</filename>,
  4551. the build system does not use it (i.e. the system does
  4552. not detect and assign the number of cores as is done with
  4553. <filename>PARALLEL_MAKE</filename>).
  4554. </para>
  4555. </glossdef>
  4556. </glossentry>
  4557. <glossentry id='var-ICECC_PATH'><glossterm>ICECC_PATH</glossterm>
  4558. <info>
  4559. ICECC_PATH[doc] = "The location of the icecc binary."
  4560. </info>
  4561. <glossdef>
  4562. <para role="glossdeffirst">
  4563. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4564. The location of the <filename>icecc</filename> binary.
  4565. You can set this variable in your
  4566. <filename>local.conf</filename> file.
  4567. If your <filename>local.conf</filename> file does not define
  4568. this variable, the
  4569. <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
  4570. class attempts to define it by locating
  4571. <filename>icecc</filename> using <filename>which</filename>.
  4572. </para>
  4573. </glossdef>
  4574. </glossentry>
  4575. <glossentry id='var-ICECC_USER_CLASS_BL'><glossterm>ICECC_USER_CLASS_BL</glossterm>
  4576. <info>
  4577. ICECC_USER_CLASS_BL[doc] = "Identifies user classes that you do not want the Icecream distributed compile support to consider."
  4578. </info>
  4579. <glossdef>
  4580. <para role="glossdeffirst">
  4581. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4582. Identifies user classes that you do not want the
  4583. Icecream distributed compile support to consider.
  4584. This variable is used by the
  4585. <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
  4586. class.
  4587. You set this variable in your
  4588. <filename>local.conf</filename> file.
  4589. </para>
  4590. <para>
  4591. When you list classes using this variable, you are
  4592. "blacklisting" them from distributed compilation across
  4593. remote hosts.
  4594. Any classes you list will be distributed and compiled
  4595. locally.
  4596. </para>
  4597. </glossdef>
  4598. </glossentry>
  4599. <glossentry id='var-ICECC_USER_PACKAGE_BL'><glossterm>ICECC_USER_PACKAGE_BL</glossterm>
  4600. <info>
  4601. ICECC_USER_PACKAGE_BL[doc] = "Identifies user recipes that you do not want the Icecream distributed compile support to consider."
  4602. </info>
  4603. <glossdef>
  4604. <para role="glossdeffirst">
  4605. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4606. Identifies user recipes that you do not want the
  4607. Icecream distributed compile support to consider.
  4608. This variable is used by the
  4609. <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
  4610. class.
  4611. You set this variable in your
  4612. <filename>local.conf</filename> file.
  4613. </para>
  4614. <para>
  4615. When you list packages using this variable, you are
  4616. "blacklisting" them from distributed compilation across
  4617. remote hosts.
  4618. Any packages you list will be distributed and compiled
  4619. locally.
  4620. </para>
  4621. </glossdef>
  4622. </glossentry>
  4623. <glossentry id='var-ICECC_USER_PACKAGE_WL'><glossterm>ICECC_USER_PACKAGE_WL</glossterm>
  4624. <info>
  4625. ICECC_USER_PACKAGE_WL[doc] = "Identifies user recipes that use an empty PARALLEL_MAKE variable that you want to force remote distributed compilation on using the Icecream distributed compile support."
  4626. </info>
  4627. <glossdef>
  4628. <para role="glossdeffirst">
  4629. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4630. Identifies user recipes that use an empty
  4631. <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>
  4632. variable that you want to force remote distributed
  4633. compilation on using the Icecream distributed compile
  4634. support.
  4635. This variable is used by the
  4636. <link linkend='ref-classes-icecc'><filename>icecc</filename></link>
  4637. class.
  4638. You set this variable in your
  4639. <filename>local.conf</filename> file.
  4640. </para>
  4641. </glossdef>
  4642. </glossentry>
  4643. <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
  4644. <info>
  4645. IMAGE_BASENAME[doc] = "The base name of image output files."
  4646. </info>
  4647. <glossdef>
  4648. <para role="glossdeffirst">
  4649. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4650. The base name of image output files.
  4651. This variable defaults to the recipe name
  4652. (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
  4653. </para>
  4654. </glossdef>
  4655. </glossentry>
  4656. <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm>
  4657. <info>
  4658. IMAGE_BOOT_FILES[doc] = "Whitespace separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same name as the source file. To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)."
  4659. </info>
  4660. <glossdef>
  4661. <para role="glossdeffirst">
  4662. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4663. A space-separated list of files installed into the
  4664. boot partition when preparing an image using the
  4665. <filename>wic</filename> tool with the
  4666. <filename>bootimg-partition</filename> source
  4667. plugin.
  4668. By default, the files are installed under
  4669. the same name as the source files.
  4670. To change the installed name, separate it from the
  4671. original name with a semi-colon (;).
  4672. Source files need to be located in
  4673. <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>.
  4674. Here are two examples:
  4675. <literallayout class="monospaced">
  4676. IMAGE_BOOT_FILES = "u-boot.img uImage;kernel"
  4677. IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}"
  4678. </literallayout>
  4679. </para>
  4680. <para>
  4681. Alternatively, source files can be picked up using
  4682. a glob pattern.
  4683. In this case, the destination file
  4684. will have the same name as the base name of the source file
  4685. path.
  4686. To install files into a directory within the
  4687. target location, pass its name after a semi-colon
  4688. (;).
  4689. Here are two examples:
  4690. <literallayout class="monospaced">
  4691. IMAGE_BOOT_FILES = "bcm2835-bootfiles/*"
  4692. IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/"
  4693. </literallayout>
  4694. The first example installs all files from
  4695. <filename>${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles</filename>
  4696. into the root of the target partition.
  4697. The second example installs the same files into a
  4698. <filename>boot</filename> directory within the
  4699. target partition.
  4700. </para>
  4701. </glossdef>
  4702. </glossentry>
  4703. <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm>
  4704. <info>
  4705. IMAGE_CLASSES[doc] = "A list of classes that all images should inherit."
  4706. </info>
  4707. <glossdef>
  4708. <para role="glossdeffirst">
  4709. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4710. A list of classes that all images should inherit.
  4711. You typically use this variable to specify the list of
  4712. classes that register the different types of images
  4713. the OpenEmbedded build system creates.
  4714. </para>
  4715. <para>
  4716. The default value for <filename>IMAGE_CLASSES</filename> is
  4717. <filename>image_types</filename>.
  4718. You can set this variable in your
  4719. <filename>local.conf</filename> or in a distribution
  4720. configuration file.
  4721. </para>
  4722. <para>
  4723. For more information, see
  4724. <filename>meta/classes/image_types.bbclass</filename> in the
  4725. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  4726. </para>
  4727. </glossdef>
  4728. </glossentry>
  4729. <glossentry id='var-IMAGE_CMD'><glossterm>IMAGE_CMD</glossterm>
  4730. <info>
  4731. IMAGE_CMD[doc] = "Specifies the command to create the image file for a specific image type, which corresponds to the value set set in IMAGE_FSTYPES, (e.g. ext3, btrfs, and so forth)."
  4732. </info>
  4733. <glossdef>
  4734. <para role="glossdeffirst">
  4735. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4736. Specifies the command to create the image file for a
  4737. specific image type, which corresponds to the value set
  4738. set in
  4739. <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>,
  4740. (e.g. <filename>ext3</filename>,
  4741. <filename>btrfs</filename>, and so forth).
  4742. When setting this variable, you should use
  4743. an override for the associated type.
  4744. Here is an example:
  4745. <literallayout class='monospaced'>
  4746. IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
  4747. --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
  4748. ${EXTRA_IMAGECMD}"
  4749. </literallayout>
  4750. </para>
  4751. <para>
  4752. You typically do not need to set this variable unless
  4753. you are adding support for a new image type.
  4754. For more examples on how to set this variable, see the
  4755. <link linkend='ref-classes-image_types'><filename>image_types</filename></link>
  4756. class file, which is
  4757. <filename>meta/classes/image_types.bbclass</filename>.
  4758. </para>
  4759. </glossdef>
  4760. </glossentry>
  4761. <glossentry id='var-IMAGE_DEVICE_TABLES'><glossterm>IMAGE_DEVICE_TABLES</glossterm>
  4762. <info>
  4763. IMAGE_DEVICE_TABLES[doc] = "Specifies one or more files that contain custom device tables that are passed to the makedevs command as part of creating an image."
  4764. </info>
  4765. <glossdef>
  4766. <para role="glossdeffirst">
  4767. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4768. Specifies one or more files that contain custom device
  4769. tables that are passed to the
  4770. <filename>makedevs</filename> command as part of creating
  4771. an image.
  4772. These files list basic device nodes that should be
  4773. created under <filename>/dev</filename> within the image.
  4774. If <filename>IMAGE_DEVICE_TABLES</filename> is not set,
  4775. <filename>files/device_table-minimal.txt</filename> is
  4776. used, which is located by
  4777. <link linkend='var-BBPATH'><filename>BBPATH</filename></link>.
  4778. For details on how you should write device table files,
  4779. see <filename>meta/files/device_table-minimal.txt</filename>
  4780. as an example.
  4781. </para>
  4782. </glossdef>
  4783. </glossentry>
  4784. <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
  4785. <info>
  4786. IMAGE_FEATURES[doc] = "The primary list of features to include in an image. Configure this variable in an image recipe."
  4787. </info>
  4788. <glossdef>
  4789. <para role="glossdeffirst">
  4790. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4791. The primary list of features to include in an image.
  4792. Typically, you configure this variable in an image recipe.
  4793. Although you can use this variable from your
  4794. <filename>local.conf</filename> file, which is found in the
  4795. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
  4796. best practices dictate that you do not.
  4797. <note>
  4798. To enable extra features from outside the image recipe,
  4799. use the
  4800. <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
  4801. </note>
  4802. </para>
  4803. <para>
  4804. For a list of image features that ships with the Yocto
  4805. Project, see the
  4806. "<link linkend="ref-features-image">Image Features</link>"
  4807. section.
  4808. </para>
  4809. <para>
  4810. For an example that shows how to customize your image by
  4811. using this variable, see the
  4812. "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>"
  4813. section in the Yocto Project Development Manual.
  4814. </para>
  4815. </glossdef>
  4816. </glossentry>
  4817. <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
  4818. <info>
  4819. IMAGE_FSTYPES[doc] = "Formats of root filesystem images that you want to have created."
  4820. </info>
  4821. <glossdef>
  4822. <para role="glossdeffirst">
  4823. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4824. Specifies the formats the OpenEmbedded build system uses
  4825. during the build when creating the root filesystem.
  4826. For example, setting <filename>IMAGE_FSTYPES</filename>
  4827. as follows causes the build system to create root
  4828. filesystems using two formats: <filename>.ext3</filename>
  4829. and <filename>.tar.bz2</filename>:
  4830. <literallayout class='monospaced'>
  4831. IMAGE_FSTYPES = "ext3 tar.bz2"
  4832. </literallayout>
  4833. </para>
  4834. <para>
  4835. For the complete list of supported image formats from which
  4836. you can choose, see
  4837. <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>.
  4838. </para>
  4839. <note>
  4840. If you add "live" to <filename>IMAGE_FSTYPES</filename>
  4841. inside an image recipe, be sure that you do so prior to the
  4842. "inherit image" line of the recipe or the live image will
  4843. not build.
  4844. </note>
  4845. <note>
  4846. Due to the way this variable is processed, it is not
  4847. possible to update its contents using
  4848. <filename>_append</filename> or
  4849. <filename>_prepend</filename>. To add one or more
  4850. additional options to this variable the
  4851. <filename>+=</filename> operator must be used.
  4852. </note>
  4853. </glossdef>
  4854. </glossentry>
  4855. <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
  4856. <info>
  4857. IMAGE_INSTALL[doc] = "Specifies the packages to install into an image. Image recipes set IMAGE_INSTALL to specify the packages to install into an image through image.bbclass."
  4858. </info>
  4859. <glossdef>
  4860. <para role="glossdeffirst">
  4861. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4862. Specifies the packages to install into an image.
  4863. The <filename>IMAGE_INSTALL</filename> variable is a
  4864. mechanism for an image recipe and you should use it
  4865. with care to avoid ordering issues.
  4866. <note>
  4867. When working with an
  4868. <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link>
  4869. image, do not use the <filename>IMAGE_INSTALL</filename>
  4870. variable to specify packages for installation.
  4871. Instead, use the
  4872. <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
  4873. variable, which allows the initial RAM disk (initramfs)
  4874. recipe to use a fixed set of packages and not be
  4875. affected by <filename>IMAGE_INSTALL</filename>.
  4876. </note>
  4877. </para>
  4878. <para>
  4879. Image recipes set <filename>IMAGE_INSTALL</filename>
  4880. to specify the packages to install into an image through
  4881. <filename>image.bbclass</filename>.
  4882. Additionally, "helper" classes exist, such as
  4883. <filename>core-image.bbclass</filename>, that can take
  4884. <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
  4885. lists and turn these into auto-generated entries in
  4886. <filename>IMAGE_INSTALL</filename> in addition to its
  4887. default contents.
  4888. </para>
  4889. <para>
  4890. Using <filename>IMAGE_INSTALL</filename> with the
  4891. <filename>+=</filename> operator from the
  4892. <filename>/conf/local.conf</filename> file or from within
  4893. an image recipe is not recommended as it can cause ordering
  4894. issues.
  4895. Since <filename>core-image.bbclass</filename> sets
  4896. <filename>IMAGE_INSTALL</filename> to a default value using
  4897. the <filename>?=</filename> operator, using a
  4898. <filename>+=</filename> operation against
  4899. <filename>IMAGE_INSTALL</filename> will result in
  4900. unexpected behavior when used in
  4901. <filename>conf/local.conf</filename>.
  4902. Furthermore, the same operation from within an image
  4903. recipe may or may not succeed depending on the specific
  4904. situation.
  4905. In both these cases, the behavior is contrary to how most
  4906. users expect the <filename>+=</filename> operator to work.
  4907. </para>
  4908. <para>
  4909. When you use this variable, it is best to use it as follows:
  4910. <literallayout class='monospaced'>
  4911. IMAGE_INSTALL_append = " <replaceable>package-name</replaceable>"
  4912. </literallayout>
  4913. Be sure to include the space between the quotation character
  4914. and the start of the package name or names.
  4915. </para>
  4916. </glossdef>
  4917. </glossentry>
  4918. <glossentry id='var-IMAGE_LINGUAS'><glossterm>IMAGE_LINGUAS</glossterm>
  4919. <info>
  4920. IMAGE_LINGUAS[doc] = "Specifies the list of locales to install into the image during the root filesystem construction process."
  4921. </info>
  4922. <glossdef>
  4923. <para role="glossdeffirst">
  4924. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4925. Specifies the list of locales to install into the image
  4926. during the root filesystem construction process.
  4927. The OpenEmbedded build system automatically splits locale
  4928. files, which are used for localization, into separate
  4929. packages.
  4930. Setting the <filename>IMAGE_LINGUAS</filename> variable
  4931. ensures that any locale packages that correspond to packages
  4932. already selected for installation into the image are also
  4933. installed.
  4934. Here is an example:
  4935. <literallayout class='monospaced'>
  4936. IMAGE_LINGUAS = "pt-br de-de"
  4937. </literallayout>
  4938. </para>
  4939. <para>
  4940. In this example, the build system ensures any Brazilian
  4941. Portuguese and German locale files that correspond to
  4942. packages in the image are installed (i.e.
  4943. <filename>*-locale-pt-br</filename>
  4944. and <filename>*-locale-de-de</filename> as well as
  4945. <filename>*-locale-pt</filename>
  4946. and <filename>*-locale-de</filename>, since some software
  4947. packages only provide locale files by language and not by
  4948. country-specific language).
  4949. </para>
  4950. <para>
  4951. See the
  4952. <link linkend='var-GLIBC_GENERATE_LOCALES'><filename>GLIBC_GENERATE_LOCALES</filename></link>
  4953. variable for information on generating GLIBC locales.
  4954. </para>
  4955. </glossdef>
  4956. </glossentry>
  4957. <glossentry id='var-IMAGE_MANIFEST'><glossterm>IMAGE_MANIFEST</glossterm>
  4958. <info>
  4959. IMAGE_MANIFEST[doc] = "The manifest file for the image. This file lists all the installed packages that make up the image."
  4960. </info>
  4961. <glossdef>
  4962. <para role="glossdeffirst">
  4963. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4964. The manifest file for the image.
  4965. This file lists all the installed packages that make up
  4966. the image.
  4967. The file contains package information on a line-per-package
  4968. basis as follows:
  4969. <literallayout class='monospaced'>
  4970. <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable>
  4971. </literallayout>
  4972. </para>
  4973. <para>
  4974. The
  4975. <link linkend='ref-classes-image'><filename>image</filename></link>
  4976. class defines the manifest file as follows:
  4977. <literallayout class='monospaced'>
  4978. IMAGE_MANIFEST = "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest"
  4979. </literallayout>
  4980. The location is derived using the
  4981. <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
  4982. and
  4983. <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>
  4984. variables.
  4985. You can find information on how the image
  4986. is created in the
  4987. "<link linkend='image-generation-dev-environment'>Image Generation</link>"
  4988. section.
  4989. </para>
  4990. </glossdef>
  4991. </glossentry>
  4992. <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm>
  4993. <info>
  4994. IMAGE_NAME[doc] = "The name of the output image files minus the extension."
  4995. </info>
  4996. <glossdef>
  4997. <para role="glossdeffirst">
  4998. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  4999. The name of the output image files minus the extension.
  5000. This variable is derived using the
  5001. <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
  5002. <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
  5003. and
  5004. <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
  5005. variables:
  5006. <literallayout class='monospaced'>
  5007. IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}"
  5008. </literallayout>
  5009. </para>
  5010. </glossdef>
  5011. </glossentry>
  5012. <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm>
  5013. <info>
  5014. IMAGE_OVERHEAD_FACTOR[doc] = "Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk usage value for the image is greater than the sum of IMAGE_ROOTFS_SIZE and IMAGE_ROOTFS_EXTRA_SPACE."
  5015. </info>
  5016. <glossdef>
  5017. <para role="glossdeffirst">
  5018. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5019. Defines a multiplier that the build system applies to the initial image
  5020. size for cases when the multiplier times the returned disk usage value
  5021. for the image is greater than the sum of
  5022. <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>
  5023. and
  5024. <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>.
  5025. The result of the multiplier applied to the initial image size creates
  5026. free disk space in the image as overhead.
  5027. By default, the build process uses a multiplier of 1.3 for this variable.
  5028. This default value results in 30% free disk space added to the image when this
  5029. method is used to determine the final generated image size.
  5030. You should be aware that post install scripts and the package management
  5031. system uses disk space inside this overhead area.
  5032. Consequently, the multiplier does not produce an image with
  5033. all the theoretical free disk space.
  5034. See <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>
  5035. for information on how the build system determines the overall image size.
  5036. </para>
  5037. <para>
  5038. The default 30% free disk space typically gives the image enough room to boot
  5039. and allows for basic post installs while still leaving a small amount of
  5040. free disk space.
  5041. If 30% free space is inadequate, you can increase the default value.
  5042. For example, the following setting gives you 50% free space added to the image:
  5043. <literallayout class='monospaced'>
  5044. IMAGE_OVERHEAD_FACTOR = "1.5"
  5045. </literallayout>
  5046. </para>
  5047. <para>
  5048. Alternatively, you can ensure a specific amount of free disk space is added
  5049. to the image by using the
  5050. <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>
  5051. variable.
  5052. </para>
  5053. </glossdef>
  5054. </glossentry>
  5055. <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm>
  5056. <info>
  5057. IMAGE_PKGTYPE[doc] = "Defines the package type (DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system."
  5058. </info>
  5059. <glossdef>
  5060. <para role="glossdeffirst">
  5061. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5062. Defines the package type (DEB, RPM, IPK, or TAR) used
  5063. by the OpenEmbedded build system.
  5064. The variable is defined appropriately by the
  5065. <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>,
  5066. <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>,
  5067. <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>,
  5068. or
  5069. <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>
  5070. class.
  5071. <note><title>Warning</title>
  5072. The <filename>package_tar</filename> class is broken
  5073. and is not supported.
  5074. It is recommended that you do not use it.
  5075. </note>
  5076. </para>
  5077. <para>
  5078. The
  5079. <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_*</filename></link>
  5080. and
  5081. <link linkend='ref-classes-image'><filename>image</filename></link>
  5082. classes use the <filename>IMAGE_PKGTYPE</filename> for
  5083. packaging up images and SDKs.
  5084. </para>
  5085. <para>
  5086. You should not set the <filename>IMAGE_PKGTYPE</filename>
  5087. manually.
  5088. Rather, the variable is set indirectly through the
  5089. appropriate
  5090. <link linkend='ref-classes-package'><filename>package_*</filename></link>
  5091. class using the
  5092. <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
  5093. variable.
  5094. The OpenEmbedded build system uses the first package type
  5095. (e.g. DEB, RPM, or IPK) that appears with the variable
  5096. <note>
  5097. Files using the <filename>.tar</filename> format are
  5098. never used as a substitute packaging format for DEB,
  5099. RPM, and IPK formatted files for your image or SDK.
  5100. </note>
  5101. </para>
  5102. </glossdef>
  5103. </glossentry>
  5104. <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm>
  5105. <info>
  5106. IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the final image output files."
  5107. </info>
  5108. <glossdef>
  5109. <para role="glossdeffirst">
  5110. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5111. Specifies a list of functions to call once the
  5112. OpenEmbedded build system has created the final image
  5113. output files.
  5114. You can specify functions separated by semicolons:
  5115. <literallayout class='monospaced'>
  5116. IMAGE_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... "
  5117. </literallayout>
  5118. </para>
  5119. <para>
  5120. If you need to pass the root filesystem path to a command
  5121. within the function, you can use
  5122. <filename>${IMAGE_ROOTFS}</filename>, which points to
  5123. the directory that becomes the root filesystem image.
  5124. See the
  5125. <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link>
  5126. variable for more information.
  5127. </para>
  5128. </glossdef>
  5129. </glossentry>
  5130. <glossentry id='var-IMAGE_PREPROCESS_COMMAND'><glossterm>IMAGE_PREPROCESS_COMMAND</glossterm>
  5131. <info>
  5132. IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the final image output files."
  5133. </info>
  5134. <glossdef>
  5135. <para role="glossdeffirst">
  5136. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5137. Specifies a list of functions to call before the
  5138. OpenEmbedded build system has created the final image
  5139. output files.
  5140. You can specify functions separated by semicolons:
  5141. <literallayout class='monospaced'>
  5142. IMAGE_PREPROCESS_COMMAND += "<replaceable>function</replaceable>; ... "
  5143. </literallayout>
  5144. </para>
  5145. <para>
  5146. If you need to pass the root filesystem path to a command
  5147. within the function, you can use
  5148. <filename>${IMAGE_ROOTFS}</filename>, which points to
  5149. the directory that becomes the root filesystem image.
  5150. See the
  5151. <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link>
  5152. variable for more information.
  5153. </para>
  5154. </glossdef>
  5155. </glossentry>
  5156. <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm>
  5157. <info>
  5158. IMAGE_ROOTFS[doc] = "The location of the root filesystem while it is under construction (i.e. during do_rootfs)."
  5159. </info>
  5160. <glossdef>
  5161. <para role="glossdeffirst">
  5162. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5163. The location of the root filesystem while it is under
  5164. construction (i.e. during the
  5165. <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
  5166. task).
  5167. This variable is not configurable.
  5168. Do not change it.
  5169. </para>
  5170. </glossdef>
  5171. </glossentry>
  5172. <glossentry id='var-IMAGE_ROOTFS_ALIGNMENT'><glossterm>IMAGE_ROOTFS_ALIGNMENT</glossterm>
  5173. <info>
  5174. IMAGE_ROOTFS_ALIGNMENT[doc] = "Specifies the alignment for the output image file in Kbytes."
  5175. </info>
  5176. <glossdef>
  5177. <para role="glossdeffirst">
  5178. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5179. Specifies the alignment for the output image file in
  5180. Kbytes.
  5181. If the size of the image is not a multiple of
  5182. this value, then the size is rounded up to the nearest
  5183. multiple of the value.
  5184. The default value is "1".
  5185. See
  5186. <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link>
  5187. for additional information.
  5188. </para>
  5189. </glossdef>
  5190. </glossentry>
  5191. <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm>
  5192. <info>
  5193. IMAGE_ROOTFS_EXTRA_SPACE[doc] = "Defines additional free disk space created in the image in Kbytes. By default, this variable is set to '0'."
  5194. </info>
  5195. <glossdef>
  5196. <para role="glossdeffirst">
  5197. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5198. Defines additional free disk space created in the image in Kbytes.
  5199. By default, this variable is set to "0".
  5200. This free disk space is added to the image after the build system determines
  5201. the image size as described in
  5202. <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>.
  5203. </para>
  5204. <para>
  5205. This variable is particularly useful when you want to ensure that a
  5206. specific amount of free disk space is available on a device after an image
  5207. is installed and running.
  5208. For example, to be sure 5 Gbytes of free disk space is available, set the
  5209. variable as follows:
  5210. <literallayout class='monospaced'>
  5211. IMAGE_ROOTFS_EXTRA_SPACE = "5242880"
  5212. </literallayout>
  5213. </para>
  5214. <para>
  5215. For example, the Yocto Project Build Appliance specifically requests 40 Gbytes
  5216. of extra space with the line:
  5217. <literallayout class='monospaced'>
  5218. IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
  5219. </literallayout>
  5220. </para>
  5221. </glossdef>
  5222. </glossentry>
  5223. <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm>
  5224. <info>
  5225. IMAGE_ROOTFS_SIZE[doc] = "Defines the size in Kbytes for the generated image."
  5226. </info>
  5227. <glossdef>
  5228. <para role="glossdeffirst">
  5229. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5230. Defines the size in Kbytes for the generated image.
  5231. The OpenEmbedded build system determines the final size for the generated
  5232. image using an algorithm that takes into account the initial disk space used
  5233. for the generated image, a requested size for the image, and requested
  5234. additional free disk space to be added to the image.
  5235. Programatically, the build system determines the final size of the
  5236. generated image as follows:
  5237. <literallayout class='monospaced'>
  5238. if (image-du * overhead) &lt; rootfs-size:
  5239. internal-rootfs-size = rootfs-size + xspace
  5240. else:
  5241. internal-rootfs-size = (image-du * overhead) + xspace
  5242. where:
  5243. image-du = Returned value of the du command on
  5244. the image.
  5245. overhead = IMAGE_OVERHEAD_FACTOR
  5246. rootfs-size = IMAGE_ROOTFS_SIZE
  5247. internal-rootfs-size = Initial root filesystem
  5248. size before any modifications.
  5249. xspace = IMAGE_ROOTFS_EXTRA_SPACE
  5250. </literallayout>
  5251. </para>
  5252. <para>
  5253. See the <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link>
  5254. and <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link>
  5255. variables for related information.
  5256. <!-- In the above example, <filename>overhead</filename> is defined by the
  5257. <filename><link linkend='var-IMAGE_OVERHEAD_FACTOR'>IMAGE_OVERHEAD_FACTOR</link></filename>
  5258. variable, <filename>xspace</filename> is defined by the
  5259. <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>
  5260. variable, and <filename>du</filename> is the results of the disk usage command
  5261. on the initially generated image. -->
  5262. </para>
  5263. </glossdef>
  5264. </glossentry>
  5265. <glossentry id='var-IMAGE_TYPEDEP'><glossterm>IMAGE_TYPEDEP</glossterm>
  5266. <info>
  5267. IMAGE_TYPEDEP[doc] = "Specifies a dependency from one image type on another."
  5268. </info>
  5269. <glossdef>
  5270. <para role="glossdeffirst">
  5271. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5272. Specifies a dependency from one image type on another.
  5273. Here is an example from the
  5274. <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
  5275. class:
  5276. <literallayout class='monospaced'>
  5277. IMAGE_TYPEDEP_live = "ext3"
  5278. </literallayout>
  5279. </para>
  5280. <para>
  5281. In the previous example, the variable ensures that when
  5282. "live" is listed with the
  5283. <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
  5284. variable, the OpenEmbedded build system produces an
  5285. <filename>ext3</filename> image first since one of the
  5286. components of the live
  5287. image is an <filename>ext3</filename>
  5288. formatted partition containing the root
  5289. filesystem.
  5290. </para>
  5291. </glossdef>
  5292. </glossentry>
  5293. <glossentry id='var-IMAGE_TYPES'><glossterm>IMAGE_TYPES</glossterm>
  5294. <info>
  5295. IMAGE_TYPES[doc] = "Specifies the complete list of supported image types by default."
  5296. </info>
  5297. <glossdef>
  5298. <para role="glossdeffirst">
  5299. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5300. Specifies the complete list of supported image types
  5301. by default:
  5302. <literallayout class='monospaced'>
  5303. btrfs
  5304. cpio
  5305. cpio.gz
  5306. cpio.lz4
  5307. cpio.lzma
  5308. cpio.xz
  5309. cramfs
  5310. elf
  5311. ext2
  5312. ext2.bz2
  5313. ext2.gz
  5314. ext2.lzma
  5315. ext3
  5316. ext3.gz
  5317. ext4
  5318. ext4.gz
  5319. hdddirect
  5320. hddimg
  5321. iso
  5322. jffs2
  5323. jffs2.sum
  5324. multiubi
  5325. qcow2
  5326. squashfs
  5327. squashfs-lzo
  5328. squashfs-xz
  5329. tar
  5330. tar.bz2
  5331. tar.gz
  5332. tar.lz4
  5333. tar.xz
  5334. ubi
  5335. ubifs
  5336. vdi
  5337. vmdk
  5338. wic
  5339. wic.bz2
  5340. wic.gz
  5341. wic.lzma
  5342. </literallayout>
  5343. </para>
  5344. <para>
  5345. For more information about these types of images, see
  5346. <filename>meta/classes/image_types*.bbclass</filename>
  5347. in the
  5348. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  5349. </para>
  5350. </glossdef>
  5351. </glossentry>
  5352. <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm>
  5353. <info>
  5354. INC_PR[doc] = "Helps define the recipe revision for recipes that share a common include file."
  5355. </info>
  5356. <glossdef>
  5357. <para role="glossdeffirst">
  5358. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5359. Helps define the recipe revision for recipes that share
  5360. a common <filename>include</filename> file.
  5361. You can think of this variable as part of the recipe revision
  5362. as set from within an include file.
  5363. </para>
  5364. <para>
  5365. Suppose, for example, you have a set of recipes that
  5366. are used across several projects.
  5367. And, within each of those recipes the revision
  5368. (its <link linkend='var-PR'><filename>PR</filename></link>
  5369. value) is set accordingly.
  5370. In this case, when the revision of those recipes changes,
  5371. the burden is on you to find all those recipes and
  5372. be sure that they get changed to reflect the updated
  5373. version of the recipe.
  5374. In this scenario, it can get complicated when recipes
  5375. that are used in many places and provide common functionality
  5376. are upgraded to a new revision.
  5377. </para>
  5378. <para>
  5379. A more efficient way of dealing with this situation is
  5380. to set the <filename>INC_PR</filename> variable inside
  5381. the <filename>include</filename> files that the recipes
  5382. share and then expand the <filename>INC_PR</filename>
  5383. variable within the recipes to help
  5384. define the recipe revision.
  5385. </para>
  5386. <para>
  5387. The following provides an example that shows how to use
  5388. the <filename>INC_PR</filename> variable
  5389. given a common <filename>include</filename> file that
  5390. defines the variable.
  5391. Once the variable is defined in the
  5392. <filename>include</filename> file, you can use the
  5393. variable to set the <filename>PR</filename> values in
  5394. each recipe.
  5395. You will notice that when you set a recipe's
  5396. <filename>PR</filename> you can provide more granular
  5397. revisioning by appending values to the
  5398. <filename>INC_PR</filename> variable:
  5399. <literallayout class='monospaced'>
  5400. recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
  5401. recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1"
  5402. recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0"
  5403. recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
  5404. </literallayout>
  5405. The first line of the example establishes the baseline
  5406. revision to be used for all recipes that use the
  5407. <filename>include</filename> file.
  5408. The remaining lines in the example are from individual
  5409. recipes and show how the <filename>PR</filename> value
  5410. is set.
  5411. </para>
  5412. </glossdef>
  5413. </glossentry>
  5414. <glossentry id='var-INCOMPATIBLE_LICENSE'><glossterm>INCOMPATIBLE_LICENSE</glossterm>
  5415. <info>
  5416. INCOMPATIBLE_LICENSE[doc] = "Specifies a space-separated list of license names (as they would appear in LICENSE) that should be excluded from the build."
  5417. </info>
  5418. <glossdef>
  5419. <para role="glossdeffirst">
  5420. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5421. Specifies a space-separated list of license names
  5422. (as they would appear in
  5423. <link linkend='var-LICENSE'><filename>LICENSE</filename></link>)
  5424. that should be excluded from the build.
  5425. Recipes that provide no alternatives to listed incompatible
  5426. licenses are not built.
  5427. Packages that are individually licensed with the specified
  5428. incompatible licenses will be deleted.
  5429. </para>
  5430. <note>
  5431. This functionality is only regularly tested using
  5432. the following setting:
  5433. <literallayout class='monospaced'>
  5434. INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0"
  5435. </literallayout>
  5436. Although you can use other settings, you might be required
  5437. to remove dependencies on or provide alternatives to
  5438. components that are required to produce a functional system
  5439. image.
  5440. </note>
  5441. </glossdef>
  5442. </glossentry>
  5443. <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
  5444. <info>
  5445. INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files."
  5446. </info>
  5447. <glossdef>
  5448. <para role="glossdeffirst">
  5449. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5450. Causes the named class to be inherited at
  5451. this point during parsing.
  5452. The variable is only valid in configuration files.
  5453. </para>
  5454. </glossdef>
  5455. </glossentry>
  5456. <glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm>
  5457. <info>
  5458. INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable."
  5459. </info>
  5460. <glossdef>
  5461. <para role="glossdeffirst">
  5462. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5463. Lists classes that will be inherited at the
  5464. distribution level.
  5465. It is unlikely that you want to edit this variable.
  5466. </para>
  5467. <para>
  5468. The default value of the variable is set as follows in the
  5469. <filename>meta/conf/distro/defaultsetup.conf</filename>
  5470. file:
  5471. <literallayout class='monospaced'>
  5472. INHERIT_DISTRO ?= "debian devshell sstate license"
  5473. </literallayout>
  5474. </para>
  5475. </glossdef>
  5476. </glossentry>
  5477. <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm>
  5478. <info>
  5479. INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS."
  5480. </info>
  5481. <glossdef>
  5482. <para role="glossdeffirst">
  5483. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5484. Prevents the default dependencies, namely the C compiler
  5485. and standard C library (libc), from being added to
  5486. <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>.
  5487. This variable is usually used within recipes that do not
  5488. require any compilation using the C compiler.
  5489. </para>
  5490. <para>
  5491. Set the variable to "1" to prevent the default dependencies
  5492. from being added.
  5493. </para>
  5494. </glossdef>
  5495. </glossentry>
  5496. <glossentry id='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><glossterm>INHIBIT_PACKAGE_DEBUG_SPLIT</glossterm>
  5497. <info>
  5498. INHIBIT_PACKAGE_DEBUG_SPLIT[doc] = "If set to "1", prevents the OpenEmbedded build system from splitting out debug information during packaging"
  5499. </info>
  5500. <glossdef>
  5501. <para role="glossdeffirst">
  5502. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5503. Prevents the OpenEmbedded build system from splitting
  5504. out debug information during packaging.
  5505. By default, the build system splits out debugging
  5506. information during the
  5507. <link linkend='ref-tasks-package'><filename>do_package</filename></link>
  5508. task.
  5509. For more information on how debug information is split out,
  5510. see the
  5511. <link linkend='var-PACKAGE_DEBUG_SPLIT_STYLE'><filename>PACKAGE_DEBUG_SPLIT_STYLE</filename></link>
  5512. variable.
  5513. </para>
  5514. <para>
  5515. To prevent the build system from splitting out
  5516. debug information during packaging, set the
  5517. <filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename> variable
  5518. as follows:
  5519. <literallayout class='monospaced'>
  5520. INHIBIT_PACKAGE_DEBUG_SPLIT = "1"
  5521. </literallayout>
  5522. </para>
  5523. </glossdef>
  5524. </glossentry>
  5525. <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm>
  5526. <info>
  5527. INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting packages."
  5528. </info>
  5529. <glossdef>
  5530. <para role="glossdeffirst">
  5531. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5532. If set to "1", causes the build to not strip binaries in
  5533. resulting packages and prevents the
  5534. <filename>-dbg</filename> package from containing the
  5535. source files.
  5536. </para>
  5537. <para>
  5538. By default, the OpenEmbedded build system strips
  5539. binaries and puts the debugging symbols into
  5540. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-dbg</filename>.
  5541. Consequently, you should not set
  5542. <filename>INHIBIT_PACKAGE_STRIP</filename> when you plan
  5543. to debug in general.
  5544. </para>
  5545. </glossdef>
  5546. </glossentry>
  5547. <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
  5548. <info>
  5549. INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot."
  5550. </info>
  5551. <glossdef>
  5552. <para role="glossdeffirst">
  5553. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5554. Defines the format for the output image of an initial
  5555. RAM disk (initramfs), which is used during boot.
  5556. Supported formats are the same as those supported by the
  5557. <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
  5558. variable.
  5559. </para>
  5560. </glossdef>
  5561. </glossentry>
  5562. <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm>
  5563. <info>
  5564. INITRAMFS_IMAGE[doc] = "Causes the OpenEmbedded build system to build an additional recipe as a dependency to your root filesystem recipe (e.g. core-image-sato)."
  5565. </info>
  5566. <glossdef>
  5567. <para role="glossdeffirst">
  5568. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5569. Causes the OpenEmbedded build system to build an additional
  5570. recipe as a dependency to your root filesystem recipe
  5571. (e.g. <filename>core-image-sato</filename>).
  5572. The additional recipe is used to create an initial RAM disk
  5573. (initramfs) that might be needed during the initial boot of
  5574. the target system to accomplish such things as loading
  5575. kernel modules prior to mounting the root file system.
  5576. </para>
  5577. <para>
  5578. When you set the variable, specify the name of the
  5579. initramfs you want created.
  5580. The following example, which is set in the
  5581. <filename>local.conf</filename> configuration file, causes
  5582. a separate recipe to be created that results in an
  5583. initramfs image named
  5584. <filename>core-image-sato-initramfs.bb</filename> to be
  5585. created:
  5586. <literallayout class='monospaced'>
  5587. INITRAMFS_IMAGE = "core-image-minimal-initramfs"
  5588. </literallayout>
  5589. By default, the
  5590. <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
  5591. class sets this variable to a null string as follows:
  5592. <literallayout class='monospaced'>
  5593. INITRAMFS_IMAGE = ""
  5594. </literallayout>
  5595. </para>
  5596. <para>
  5597. See the
  5598. <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink>
  5599. file for additional information.
  5600. You can also reference the
  5601. <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/kernel.bbclass'><filename>kernel.bbclass</filename></ulink>
  5602. file to see how the variable is used.
  5603. </para>
  5604. </glossdef>
  5605. </glossentry>
  5606. <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm>
  5607. <info>
  5608. INITRAMFS_IMAGE_BUNDLE[doc] = "Controls whether or not the image recipe specified by INITRAMFS_IMAGE is run through an extra pass during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM disk (initramfs)."
  5609. </info>
  5610. <glossdef>
  5611. <para role="glossdeffirst">
  5612. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5613. Controls whether or not the image recipe specified by
  5614. <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link>
  5615. is run through an extra pass during kernel compilation
  5616. in order to build a single binary that contains both the
  5617. kernel image and the initial RAM disk (initramfs).
  5618. Using an extra compilation pass ensures that when a kernel
  5619. attempts to use an initramfs, it does not encounter
  5620. circular dependencies should the initramfs include kernel
  5621. modules.
  5622. </para>
  5623. <para>
  5624. The combined binary is deposited into the
  5625. <filename>tmp/deploy</filename> directory, which is part
  5626. of the
  5627. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  5628. </para>
  5629. <para>
  5630. Setting the variable to "1" in a configuration file causes
  5631. the OpenEmbedded build system to make the extra pass during
  5632. kernel compilation:
  5633. <literallayout class='monospaced'>
  5634. INITRAMFS_IMAGE_BUNDLE = "1"
  5635. </literallayout>
  5636. By default, the
  5637. <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
  5638. class sets this variable to a null string as follows:
  5639. <literallayout class='monospaced'>
  5640. INITRAMFS_IMAGE_BUNDLE = ""
  5641. </literallayout>
  5642. <note>
  5643. You must set the
  5644. <filename>INITRAMFS_IMAGE_BUNDLE</filename> variable in
  5645. a configuration file.
  5646. You cannot set the variable in a recipe file.
  5647. </note>
  5648. See the
  5649. <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink>
  5650. file for additional information.
  5651. </para>
  5652. </glossdef>
  5653. </glossentry>
  5654. <glossentry id='var-INITRD'><glossterm>INITRD</glossterm>
  5655. <info>
  5656. INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk (initrd)."
  5657. </info>
  5658. <glossdef>
  5659. <para role="glossdeffirst">
  5660. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5661. Indicates list of filesystem images to concatenate and use
  5662. as an initial RAM disk (<filename>initrd</filename>).
  5663. </para>
  5664. <para>
  5665. The <filename>INITRD</filename> variable is an optional
  5666. variable used with the
  5667. <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
  5668. class.
  5669. </para>
  5670. </glossdef>
  5671. </glossentry>
  5672. <glossentry id='var-INITRD_IMAGE'><glossterm>INITRD_IMAGE</glossterm>
  5673. <info>
  5674. INITRD_IMAGE[doc] = "When building a "live" bootable image (i.e. when IMAGE_FSTYPES contains "live"), INITRD_IMAGE specifies the image recipe that should be built to provide the initial RAM disk image."
  5675. </info>
  5676. <glossdef>
  5677. <para role="glossdeffirst">
  5678. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5679. When building a "live" bootable image (i.e. when
  5680. <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
  5681. contains "live"), <filename>INITRD_IMAGE</filename>
  5682. specifies the image recipe that should be built
  5683. to provide the initial RAM disk image.
  5684. The default value is "core-image-minimal-initramfs".
  5685. </para>
  5686. <para>
  5687. See the
  5688. <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
  5689. class for more information.
  5690. </para>
  5691. </glossdef>
  5692. </glossentry>
  5693. <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm>
  5694. <info>
  5695. INITSCRIPT_NAME[doc] = "The filename of the initialization script as installed to ${sysconfdir}/init.d."
  5696. </info>
  5697. <glossdef>
  5698. <para role="glossdeffirst">
  5699. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5700. The filename of the initialization script as installed to
  5701. <filename>${sysconfdir}/init.d</filename>.
  5702. </para>
  5703. <para>
  5704. This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>.
  5705. The variable is mandatory.
  5706. </para>
  5707. </glossdef>
  5708. </glossentry>
  5709. <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
  5710. <info>
  5711. INITSCRIPT_PACKAGES[doc] = "A list of the packages that contain initscripts. This variable is used in recipes when using update-rc.d.bbclass. The variable is optional and defaults to the PN variable."
  5712. </info>
  5713. <glossdef>
  5714. <para role="glossdeffirst">
  5715. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5716. A list of the packages that contain initscripts.
  5717. If multiple packages are specified, you need to append the package name
  5718. to the other <filename>INITSCRIPT_*</filename> as an override.
  5719. </para>
  5720. <para>
  5721. This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>.
  5722. The variable is optional and defaults to the
  5723. <link linkend='var-PN'><filename>PN</filename></link> variable.
  5724. </para>
  5725. </glossdef>
  5726. </glossentry>
  5727. <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm>
  5728. <info>
  5729. INITSCRIPT_PARAMS[doc] = "Specifies the options to pass to update-rc.d. The variable is mandatory and is used in recipes when using update-rc.d.bbclass."
  5730. </info>
  5731. <glossdef>
  5732. <para role="glossdeffirst">
  5733. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5734. Specifies the options to pass to <filename>update-rc.d</filename>.
  5735. Here is an example:
  5736. <literallayout class='monospaced'>
  5737. INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ."
  5738. </literallayout>
  5739. </para>
  5740. <para>
  5741. In this example, the script has a runlevel of 99,
  5742. starts the script in initlevels 2 and 5, and
  5743. stops the script in levels 0, 1 and 6.
  5744. </para>
  5745. <para>
  5746. The variable's default value is "defaults", which is
  5747. set in the
  5748. <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link>
  5749. class.
  5750. </para>
  5751. <para>
  5752. The value in
  5753. <filename>INITSCRIPT_PARAMS</filename> is passed through
  5754. to the <filename>update-rc.d</filename> command.
  5755. For more information on valid parameters, please see the
  5756. <filename>update-rc.d</filename> manual page at
  5757. <ulink url='http://www.tin.org/bin/man.cgi?section=8&amp;topic=update-rc.d'></ulink>.
  5758. </para>
  5759. </glossdef>
  5760. </glossentry>
  5761. <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm>
  5762. <info>
  5763. INSANE_SKIP[doc] = "Specifies the QA checks to skip for a specific package within a recipe."
  5764. </info>
  5765. <glossdef>
  5766. <para role="glossdeffirst">
  5767. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5768. Specifies the QA checks to skip for a specific package
  5769. within a recipe.
  5770. For example, to skip the check for symbolic link
  5771. <filename>.so</filename> files in the main package of a
  5772. recipe, add the following to the recipe.
  5773. The package name override must be used, which in this
  5774. example is <filename>${PN}</filename>:
  5775. <literallayout class='monospaced'>
  5776. INSANE_SKIP_${PN} += "dev-so"
  5777. </literallayout>
  5778. </para>
  5779. <para>
  5780. See the "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
  5781. section for a list of the valid QA checks you can
  5782. specify using this variable.
  5783. </para>
  5784. </glossdef>
  5785. </glossentry>
  5786. <glossentry id='var-INSTALL_TIMEZONE_FILE'><glossterm>INSTALL_TIMEZONE_FILE</glossterm>
  5787. <info>
  5788. INSTALL_TIMEZONE_FILE[doc] = "Enables installation of the /etc/timezone file."
  5789. </info>
  5790. <glossdef>
  5791. <para role="glossdeffirst">
  5792. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5793. By default, the <filename>tzdata</filename> recipe packages
  5794. an <filename>/etc/timezone</filename> file.
  5795. Set the <filename>INSTALL_TIMEZONE_FILE</filename>
  5796. variable to "0" at the configuration level to disable this
  5797. behavior.
  5798. </para>
  5799. </glossdef>
  5800. </glossentry>
  5801. <glossentry id='var-IPK_FEED_URIS'><glossterm>IPK_FEED_URIS</glossterm>
  5802. <info>
  5803. IPK_FEED_URIS[doc] = "List of ipkg feed records to put into generated image."
  5804. </info>
  5805. <glossdef>
  5806. <para role="glossdeffirst">
  5807. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5808. When the IPK backend is in use and package management
  5809. is enabled on the target, you can use this variable to
  5810. set up <filename>opkg</filename> in the target image
  5811. to point to package feeds on a nominated server.
  5812. Once the feed is established, you can perform
  5813. installations or upgrades using the package manager
  5814. at runtime.
  5815. </para>
  5816. </glossdef>
  5817. </glossentry>
  5818. <!--
  5819. <glossentry id='var-INTERCEPT_DIR'><glossterm>INTERCEPT_DIR</glossterm>
  5820. <glossdef>
  5821. <para>
  5822. An environment variable that defines the directory where
  5823. post installation hooks are installed for the
  5824. post install environment.
  5825. This variable is fixed as follows:
  5826. <literallayout class='monospaced'>
  5827. ${WORKDIR}/intercept_scripts
  5828. </literallayout>
  5829. </para>
  5830. <para>
  5831. After installation of a target's root filesystem,
  5832. post installation scripts, which are essentially bash scripts,
  5833. are all executed just a single time.
  5834. Limiting execution of these scripts minimizes installation
  5835. time that would be lengthened due to certain packages
  5836. triggering redundant operations.
  5837. For example, consider the installation of font packages
  5838. as a common example.
  5839. Without limiting the execution of post installation scripts,
  5840. all font directories would be rescanned to create the
  5841. cache after each individual font package was installed.
  5842. </para>
  5843. <para>
  5844. Do not edit the <filename>INTERCEPT_DIR</filename>
  5845. variable.
  5846. </para>
  5847. </glossdef>
  5848. </glossentry>
  5849. -->
  5850. </glossdiv>
  5851. <!-- <glossdiv id='var-glossary-j'><title>J</title>-->
  5852. <!-- </glossdiv>-->
  5853. <glossdiv id='var-glossary-k'><title>K</title>
  5854. <glossentry id='var-KARCH'><glossterm>KARCH</glossterm>
  5855. <info>
  5856. KARCH[doc] = "Defines the kernel architecture used when assembling the configuration. You define the KARCH variable in the BSP Descriptions."
  5857. </info>
  5858. <glossdef>
  5859. <para role="glossdeffirst">
  5860. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5861. Defines the kernel architecture used when assembling
  5862. the configuration.
  5863. Architectures supported for this release are:
  5864. <literallayout class='monospaced'>
  5865. powerpc
  5866. i386
  5867. x86_64
  5868. arm
  5869. qemu
  5870. mips
  5871. </literallayout>
  5872. </para>
  5873. <para>
  5874. You define the <filename>KARCH</filename> variable in the
  5875. <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>.
  5876. </para>
  5877. </glossdef>
  5878. </glossentry>
  5879. <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm>
  5880. <info>
  5881. KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched and configured during a build."
  5882. </info>
  5883. <glossdef>
  5884. <para role="glossdeffirst">
  5885. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5886. A regular expression used by the build process to explicitly
  5887. identify the kernel branch that is validated, patched,
  5888. and configured during a build.
  5889. You must set this variable to ensure the exact kernel
  5890. branch you want is being used by the build process.
  5891. </para>
  5892. <para>
  5893. Values for this variable are set in the kernel's recipe
  5894. file and the kernel's append file.
  5895. For example, if you are using the Yocto Project kernel that
  5896. is based on the Linux 3.14 kernel, the kernel recipe file
  5897. is the
  5898. <filename>meta/recipes-kernel/linux/linux-yocto_3.14.bb</filename>
  5899. file.
  5900. Following is an example for a kernel recipe file:
  5901. <literallayout class='monospaced'>
  5902. KBRANCH ?= "standard/base"
  5903. </literallayout>
  5904. </para>
  5905. <para>
  5906. This variable is also used from the kernel's append file
  5907. to identify the kernel branch specific to a particular
  5908. machine or target hardware.
  5909. The kernel's append file is located in the BSP layer for
  5910. a given machine.
  5911. For example, the kernel append file for the Emenlow BSP is in the
  5912. <filename>meta-intel</filename> Git repository and is named
  5913. <filename>meta-emenlow/recipes-kernel/linux/linux-yocto_3.14.bbappend</filename>.
  5914. Here are the related statements from the append file:
  5915. <literallayout class='monospaced'>
  5916. COMPATIBLE_MACHINE_emenlow-noemgd = "emenlow-noemgd"
  5917. KMACHINE_emenlow-noemgd = "emenlow"
  5918. KBRANCH_emenlow-noemgd = "standard/base"
  5919. KERNEL_FEATURES_append_emenlow-noemgd = " features/drm-gma500/drm-gma500.scc"
  5920. </literallayout>
  5921. The <filename>KBRANCH</filename> statement identifies
  5922. the kernel branch to use when building for the Emenlow
  5923. BSP.
  5924. </para>
  5925. </glossdef>
  5926. </glossentry>
  5927. <glossentry id='var-KBUILD_DEFCONFIG'><glossterm>KBUILD_DEFCONFIG</glossterm>
  5928. <info>
  5929. KBUILD_DEFCONFIG[doc] = "Specifies an "in-tree" kernel configuration file for use during a kernel build."
  5930. </info>
  5931. <glossdef>
  5932. <para role="glossdeffirst">
  5933. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5934. When used with the
  5935. <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link>
  5936. class, specifies an "in-tree" kernel configuration file
  5937. for use during a kernel build.
  5938. </para>
  5939. <para>
  5940. Typically, when using a <filename>defconfig</filename> to
  5941. configure a kernel during a build, you place the
  5942. file in your layer in the same manner as you would
  5943. patch files and configuration fragment files (i.e.
  5944. "out-of-tree").
  5945. However, if you want to use a <filename>defconfig</filename>
  5946. file that is part of the kernel tree (i.e. "in-tree"),
  5947. you can use the
  5948. <filename>KBUILD_DEFCONFIG</filename> variable to point
  5949. to the <filename>defconfig</filename> file.
  5950. </para>
  5951. <para>
  5952. To use the variable, set it in the append file for your
  5953. kernel recipe using the following form:
  5954. <literallayout class='monospaced'>
  5955. KBUILD_DEFCONFIG_<link linkend='var-KMACHINE'>KMACHINE</link> ?= <replaceable>defconfig_file</replaceable>
  5956. </literallayout>
  5957. Here is an example from a "raspberrypi2"
  5958. <filename>KMACHINE</filename> build that uses a
  5959. <filename>defconfig</filename> file named
  5960. "bcm2709_defconfig":
  5961. <literallayout class='monospaced'>
  5962. KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig"
  5963. </literallayout>
  5964. As an alternative, you can use the following within your
  5965. append file:
  5966. <literallayout class='monospaced'>
  5967. KBUILD_DEFCONFIG_pn-linux-yocto ?= <replaceable>defconfig_file</replaceable>
  5968. </literallayout>
  5969. For more information on how to use the
  5970. <filename>KBUILD_DEFCONFIG</filename> variable, see the
  5971. "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-an-in-tree-defconfig-file'>Using an "In-Tree" <filename>defconfig</filename> File</ulink>"
  5972. section.
  5973. </para>
  5974. </glossdef>
  5975. </glossentry>
  5976. <glossentry id='var-KERNEL_ALT_IMAGETYPE'><glossterm>KERNEL_ALT_IMAGETYPE</glossterm>
  5977. <info>
  5978. KERNEL_ALT_IMAGETYPE[doc] = "Specifies an alternate kernel image type for creation."
  5979. </info>
  5980. <glossdef>
  5981. <para role="glossdeffirst">
  5982. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5983. Specifies an alternate kernel image type for creation in
  5984. addition to the kernel image type specified using the
  5985. <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>
  5986. variable.
  5987. </para>
  5988. </glossdef>
  5989. </glossentry>
  5990. <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm>
  5991. <info>
  5992. KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit."
  5993. </info>
  5994. <glossdef>
  5995. <para role="glossdeffirst">
  5996. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  5997. A list of classes defining kernel image types that the
  5998. <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
  5999. class should inherit.
  6000. You typically append this variable to enable extended image
  6001. types.
  6002. An example is the "kernel-fitimage", which enables
  6003. fitImage support and resides in
  6004. <filename>meta/classes/kernel-fitimage.bbclass</filename>.
  6005. You can register custom kernel image types with the
  6006. <filename>kernel</filename> class using this variable.
  6007. </para>
  6008. </glossdef>
  6009. </glossentry>
  6010. <glossentry id='var-KERNEL_DEVICETREE'><glossterm>KERNEL_DEVICETREE</glossterm>
  6011. <info>
  6012. KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the <filename>.dtb</filename>) file."
  6013. </info>
  6014. <glossdef>
  6015. <para role="glossdeffirst">
  6016. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6017. Specifies the name of the generated Linux kernel device tree
  6018. (i.e. the <filename>.dtb</filename>) file.
  6019. <note>
  6020. Legacy support exists for specifying the full path
  6021. to the device tree.
  6022. However, providing just the <filename>.dtb</filename>
  6023. file is preferred.
  6024. </note>
  6025. In order to use this variable, you must have the include
  6026. files in your kernel recipe:
  6027. <literallayout class='monospaced'>
  6028. require recipes-kernel/linux/linux-dtb.inc
  6029. </literallayout>
  6030. or
  6031. <literallayout class='monospaced'>
  6032. require recipes-kernel/linux/linux-yocto.inc
  6033. </literallayout>
  6034. </para>
  6035. </glossdef>
  6036. </glossentry>
  6037. <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm>
  6038. <info>
  6039. KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel."
  6040. </info>
  6041. <glossdef>
  6042. <para role="glossdeffirst">
  6043. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6044. Specifies additional <filename>make</filename>
  6045. command-line arguments the OpenEmbedded build system
  6046. passes on when compiling the kernel.
  6047. </para>
  6048. </glossdef>
  6049. </glossentry>
  6050. <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm>
  6051. <info>
  6052. KERNEL_FEATURES[doc] = "Includes additional metadata from the Yocto Project kernel Git repository. The metadata you add through this variable includes config fragments and features descriptions."
  6053. </info>
  6054. <glossdef>
  6055. <para role="glossdeffirst">
  6056. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6057. Includes additional metadata from the Yocto Project kernel Git repository.
  6058. In the OpenEmbedded build system, the default Board Support Packages (BSPs)
  6059. <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
  6060. is provided through
  6061. the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>
  6062. and <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> variables.
  6063. You can use the <filename>KERNEL_FEATURES</filename> variable to further
  6064. add metadata for all BSPs.
  6065. </para>
  6066. <para>
  6067. The metadata you add through this variable includes config fragments and
  6068. features descriptions,
  6069. which usually includes patches as well as config fragments.
  6070. You typically override the <filename>KERNEL_FEATURES</filename> variable
  6071. for a specific machine.
  6072. In this way, you can provide validated, but optional, sets of kernel
  6073. configurations and features.
  6074. </para>
  6075. <para>
  6076. For example, the following adds <filename>netfilter</filename> to all
  6077. the Yocto Project kernels and adds sound support to the <filename>qemux86</filename>
  6078. machine:
  6079. <literallayout class='monospaced'>
  6080. # Add netfilter to all linux-yocto kernels
  6081. KERNEL_FEATURES="features/netfilter/netfilter.scc"
  6082. # Add sound support to the qemux86 machine
  6083. KERNEL_FEATURES_append_qemux86=" cfg/sound.scc"
  6084. </literallayout></para>
  6085. </glossdef>
  6086. </glossentry>
  6087. <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm>
  6088. <info>
  6089. KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image."
  6090. </info>
  6091. <glossdef>
  6092. <para role="glossdeffirst">
  6093. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6094. The base name of the kernel image.
  6095. This variable is set in the
  6096. <link linkend='ref-classes-kernel'>kernel</link> class
  6097. as follows:
  6098. <literallayout class='monospaced'>
  6099. KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}"
  6100. </literallayout>
  6101. </para>
  6102. <para>
  6103. See the
  6104. <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>,
  6105. <link linkend='var-PKGE'><filename>PKGE</filename></link>,
  6106. <link linkend='var-PKGV'><filename>PKGV</filename></link>,
  6107. <link linkend='var-PKGR'><filename>PKGR</filename></link>,
  6108. <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
  6109. and
  6110. <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
  6111. variables for additional information.
  6112. </para>
  6113. </glossdef>
  6114. </glossentry>
  6115. <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm>
  6116. <info>
  6117. KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file."
  6118. </info>
  6119. <glossdef>
  6120. <para role="glossdeffirst">
  6121. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6122. Specifies the maximum size of the kernel image file in
  6123. kilobytes.
  6124. If <filename>KERNEL_IMAGE_MAXSIZE</filename> is set,
  6125. the size of the kernel image file is checked against
  6126. the set value during the
  6127. <link linkend='ref-tasks-sizecheck'><filename>do_sizecheck</filename></link>
  6128. task.
  6129. The task fails if the kernel image file is larger than
  6130. the setting.
  6131. </para>
  6132. <para>
  6133. <filename>KERNEL_IMAGE_MAXSIZE</filename> is useful for
  6134. target devices that have a limited amount of space in
  6135. which the kernel image must be stored.
  6136. </para>
  6137. <para>
  6138. By default, this variable is not set, which means the
  6139. size of the kernel image is not checked.
  6140. </para>
  6141. </glossdef>
  6142. </glossentry>
  6143. <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
  6144. <info>
  6145. KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'."
  6146. </info>
  6147. <glossdef>
  6148. <para role="glossdeffirst">
  6149. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6150. The type of kernel to build for a device, usually set by the
  6151. machine configuration files and defaults to "zImage".
  6152. This variable is used
  6153. when building the kernel and is passed to <filename>make</filename> as the target to
  6154. build.
  6155. </para>
  6156. <para>
  6157. If you want to build an alternate kernel image type, use the
  6158. <link linkend='var-KERNEL_ALT_IMAGETYPE'><filename>KERNEL_ALT_IMAGETYPE</filename></link>
  6159. variable.
  6160. </para>
  6161. </glossdef>
  6162. </glossentry>
  6163. <glossentry id='var-KERNEL_MODULE_AUTOLOAD'><glossterm>KERNEL_MODULE_AUTOLOAD</glossterm>
  6164. <info>
  6165. KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded during boot"
  6166. </info>
  6167. <glossdef>
  6168. <para role="glossdeffirst">
  6169. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6170. Lists kernel modules that need to be auto-loaded during
  6171. boot.
  6172. <note>
  6173. This variable replaces the deprecated
  6174. <link linkend='var-module_autoload'><filename>module_autoload</filename></link>
  6175. variable.
  6176. </note>
  6177. </para>
  6178. <para>
  6179. You can use the <filename>KERNEL_MODULE_AUTOLOAD</filename>
  6180. variable anywhere that it can be
  6181. recognized by the kernel recipe or by an out-of-tree kernel
  6182. module recipe (e.g. a machine configuration file, a
  6183. distribution configuration file, an append file for the
  6184. recipe, or the recipe itself).
  6185. </para>
  6186. <para>
  6187. Specify it as follows:
  6188. <literallayout class='monospaced'>
  6189. KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name1</replaceable> <replaceable>module_name2</replaceable> <replaceable>module_name3</replaceable>"
  6190. </literallayout>
  6191. </para>
  6192. <para>
  6193. Including <filename>KERNEL_MODULE_AUTOLOAD</filename> causes
  6194. the OpenEmbedded build system to populate the
  6195. <filename>/etc/modules-load.d/modname.conf</filename>
  6196. file with the list of modules to be auto-loaded on boot.
  6197. The modules appear one-per-line in the file.
  6198. Here is an example of the most common use case:
  6199. <literallayout class='monospaced'>
  6200. KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name</replaceable>"
  6201. </literallayout>
  6202. </para>
  6203. <para>
  6204. For information on how to populate the
  6205. <filename>modname.conf</filename> file with
  6206. <filename>modprobe.d</filename> syntax lines, see the
  6207. <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link>
  6208. variable.
  6209. </para>
  6210. </glossdef>
  6211. </glossentry>
  6212. <glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm>
  6213. <info>
  6214. KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules."
  6215. </info>
  6216. <glossdef>
  6217. <para role="glossdeffirst">
  6218. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6219. Provides a list of modules for which the OpenEmbedded
  6220. build system expects to find
  6221. <filename>module_conf_</filename><replaceable>modname</replaceable>
  6222. values that specify configuration for each of the modules.
  6223. For information on how to provide those module
  6224. configurations, see the
  6225. <link linkend='var-module_conf'><filename>module_conf_*</filename></link>
  6226. variable.
  6227. </para>
  6228. </glossdef>
  6229. </glossentry>
  6230. <glossentry id='var-KERNEL_PATH'><glossterm>KERNEL_PATH</glossterm>
  6231. <info>
  6232. KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
  6233. </info>
  6234. <glossdef>
  6235. <para role="glossdeffirst">
  6236. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6237. The location of the kernel sources.
  6238. This variable is set to the value of the
  6239. <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link>
  6240. within the
  6241. <link linkend='ref-classes-module'><filename>module</filename></link>
  6242. class.
  6243. For information on how this variable is used, see the
  6244. "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
  6245. section.
  6246. </para>
  6247. <para>
  6248. To help maximize compatibility with out-of-tree drivers
  6249. used to build modules, the OpenEmbedded build system also
  6250. recognizes and uses the
  6251. <link linkend='var-KERNEL_SRC'><filename>KERNEL_SRC</filename></link>
  6252. variable, which is identical to the
  6253. <filename>KERNEL_PATH</filename> variable.
  6254. Both variables are common variables used by external
  6255. Makefiles to point to the kernel source directory.
  6256. </para>
  6257. </glossdef>
  6258. </glossentry>
  6259. <glossentry id='var-KERNEL_SRC'><glossterm>KERNEL_SRC</glossterm>
  6260. <info>
  6261. KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)."
  6262. </info>
  6263. <glossdef>
  6264. <para role="glossdeffirst">
  6265. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6266. The location of the kernel sources.
  6267. This variable is set to the value of the
  6268. <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link>
  6269. within the
  6270. <link linkend='ref-classes-module'><filename>module</filename></link>
  6271. class.
  6272. For information on how this variable is used, see the
  6273. "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
  6274. section.
  6275. </para>
  6276. <para>
  6277. To help maximize compatibility with out-of-tree drivers
  6278. used to build modules, the OpenEmbedded build system also
  6279. recognizes and uses the
  6280. <link linkend='var-KERNEL_PATH'><filename>KERNEL_PATH</filename></link>
  6281. variable, which is identical to the
  6282. <filename>KERNEL_SRC</filename> variable.
  6283. Both variables are common variables used by external
  6284. Makefiles to point to the kernel source directory.
  6285. </para>
  6286. </glossdef>
  6287. </glossentry>
  6288. <glossentry id='var-KERNEL_VERSION'><glossterm>KERNEL_VERSION</glossterm>
  6289. <info>
  6290. KERNEL_VERSION[doc] = "Specifies the version of the kernel as extracted from version.h or utsrelease.h within the kernel sources."
  6291. </info>
  6292. <glossdef>
  6293. <para role="glossdeffirst">
  6294. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6295. Specifies the version of the kernel as extracted from
  6296. <filename>version.h</filename> or
  6297. <filename>utsrelease.h</filename> within the kernel sources.
  6298. Effects of setting this variable do not take affect until
  6299. the kernel has been configured.
  6300. Consequently, attempting to refer to this variable in
  6301. contexts prior to configuration will not work.
  6302. </para>
  6303. </glossdef>
  6304. </glossentry>
  6305. <glossentry id='var-KERNELDEPMODDEPEND'><glossterm>KERNELDEPMODDEPEND</glossterm>
  6306. <info>
  6307. KERNELDEPMODDEPEND[doc] = "Specifies whether or not to use the data referenced through the PKGDATA_DIR directory."
  6308. </info>
  6309. <glossdef>
  6310. <para role="glossdeffirst">
  6311. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6312. Specifies whether the data referenced through
  6313. <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
  6314. is needed or not.
  6315. The <filename>KERNELDEPMODDEPEND</filename> does not
  6316. control whether or not that data exists,
  6317. but simply whether or not it is used.
  6318. If you do not need to use the data, set the
  6319. <filename>KERNELDEPMODDEPEND</filename> variable in your
  6320. <filename>initramfs</filename> recipe.
  6321. Setting the variable there when the data is not needed
  6322. avoids a potential dependency loop.
  6323. </para>
  6324. </glossdef>
  6325. </glossentry>
  6326. <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm>
  6327. <info>
  6328. KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file."
  6329. </info>
  6330. <glossdef>
  6331. <para role="glossdeffirst">
  6332. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6333. Provides a short description of a configuration fragment.
  6334. You use this variable in the <filename>.scc</filename>
  6335. file that describes a configuration fragment file.
  6336. Here is the variable used in a file named
  6337. <filename>smp.scc</filename> to describe SMP being
  6338. enabled:
  6339. <literallayout class='monospaced'>
  6340. define KFEATURE_DESCRIPTION "Enable SMP"
  6341. </literallayout>
  6342. </para>
  6343. </glossdef>
  6344. </glossentry>
  6345. <glossentry id='var-KMACHINE'><glossterm>KMACHINE</glossterm>
  6346. <info>
  6347. KMACHINE[doc] = "The machine as known by the kernel."
  6348. </info>
  6349. <glossdef>
  6350. <para role="glossdeffirst">
  6351. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6352. The machine as known by the kernel.
  6353. Sometimes the machine name used by the kernel does not
  6354. match the machine name used by the OpenEmbedded build
  6355. system.
  6356. For example, the machine name that the OpenEmbedded build
  6357. system understands as
  6358. <filename>core2-32-intel-common</filename> goes by a
  6359. different name in the Linux Yocto kernel.
  6360. The kernel understands that machine as
  6361. <filename>intel-core2-32</filename>.
  6362. For cases like these, the <filename>KMACHINE</filename>
  6363. variable maps the kernel machine name to the OpenEmbedded
  6364. build system machine name.
  6365. </para>
  6366. <para>
  6367. These mappings between different names occur in the
  6368. Yocto Linux Kernel's <filename>meta</filename> branch.
  6369. As an example take a look in the
  6370. <filename>common/recipes-kernel/linux/linux-yocto_3.19.bbappend</filename>
  6371. file:
  6372. <literallayout class='monospaced'>
  6373. LINUX_VERSION_core2-32-intel-common = "3.19.0"
  6374. COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}"
  6375. SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974"
  6376. SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
  6377. KMACHINE_core2-32-intel-common = "intel-core2-32"
  6378. KBRANCH_core2-32-intel-common = "standard/base"
  6379. KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}"
  6380. </literallayout>
  6381. The <filename>KMACHINE</filename> statement says that
  6382. the kernel understands the machine name as
  6383. "intel-core2-32".
  6384. However, the OpenEmbedded build system understands the
  6385. machine as "core2-32-intel-common".
  6386. </para>
  6387. </glossdef>
  6388. </glossentry>
  6389. <glossentry id='var-KTYPE'><glossterm>KTYPE</glossterm>
  6390. <info>
  6391. KTYPE[doc] = "Defines the kernel type to be used in assembling the configuration."
  6392. </info>
  6393. <glossdef>
  6394. <para role="glossdeffirst">
  6395. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6396. Defines the kernel type to be used in assembling the
  6397. configuration.
  6398. The linux-yocto recipes define "standard", "tiny",
  6399. and "preempt-rt" kernel types.
  6400. See the
  6401. "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>"
  6402. section in the Yocto Project Linux Kernel Development
  6403. Manual for more information on kernel types.
  6404. </para>
  6405. <para>
  6406. You define the <filename>KTYPE</filename> variable in the
  6407. <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>.
  6408. The value you use must match the value used for the
  6409. <link linkend='var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></link>
  6410. value used by the kernel recipe.
  6411. </para>
  6412. </glossdef>
  6413. </glossentry>
  6414. </glossdiv>
  6415. <glossdiv id='var-glossary-l'><title>L</title>
  6416. <glossentry id='var-LABELS'><glossterm>LABELS</glossterm>
  6417. <info>
  6418. LABELS[doc] = "Provides a list of targets for automatic configuration."
  6419. </info>
  6420. <glossdef>
  6421. <para role="glossdeffirst">
  6422. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6423. Provides a list of targets for automatic configuration.
  6424. </para>
  6425. <para>
  6426. See the
  6427. <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link>
  6428. class for more information on how this variable is used.
  6429. </para>
  6430. </glossdef>
  6431. </glossentry>
  6432. <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
  6433. <info>
  6434. LAYERDEPENDS[doc] = "Lists the layers, separated by spaces, upon which this recipe depends. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer."
  6435. </info>
  6436. <glossdef>
  6437. <para role="glossdeffirst">
  6438. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6439. Lists the layers that this recipe depends upon, separated by spaces.
  6440. Optionally, you can specify a specific layer version for a dependency
  6441. by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3"
  6442. to be compared against
  6443. <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename>
  6444. in this case).
  6445. An error will be produced if any dependency is missing or
  6446. the version numbers do not match exactly (if specified).
  6447. This variable is used in the <filename>conf/layer.conf</filename> file
  6448. and must be suffixed with the name of the specific layer (e.g.
  6449. <filename>LAYERDEPENDS_mylayer</filename>).
  6450. </para>
  6451. </glossdef>
  6452. </glossentry>
  6453. <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
  6454. <info>
  6455. LAYERDIR[doc] = "When used inside the layer.conf configuration file, this variable provides the path of the current layer."
  6456. </info>
  6457. <glossdef>
  6458. <para role="glossdeffirst">
  6459. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6460. When used inside the <filename>layer.conf</filename> configuration
  6461. file, this variable provides the path of the current layer.
  6462. This variable is not available outside of <filename>layer.conf</filename>
  6463. and references are expanded immediately when parsing of the file completes.
  6464. </para>
  6465. </glossdef>
  6466. </glossentry>
  6467. <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
  6468. <info>
  6469. LAYERVERSION[doc] = "Optionally specifies the version of a layer as a single number. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer."
  6470. </info>
  6471. <glossdef>
  6472. <para role="glossdeffirst">
  6473. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6474. Optionally specifies the version of a layer as a single number.
  6475. You can use this within
  6476. <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link>
  6477. for another layer in order to depend on a specific version
  6478. of the layer.
  6479. This variable is used in the <filename>conf/layer.conf</filename> file
  6480. and must be suffixed with the name of the specific layer (e.g.
  6481. <filename>LAYERVERSION_mylayer</filename>).
  6482. </para>
  6483. </glossdef>
  6484. </glossentry>
  6485. <glossentry id='var-LD'><glossterm>LD</glossterm>
  6486. <info>
  6487. LD[doc] = "Minimal command and arguments to run the linker."
  6488. </info>
  6489. <glossdef>
  6490. <para role="glossdeffirst">
  6491. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6492. The minimal command and arguments used to run the
  6493. linker.
  6494. </para>
  6495. </glossdef>
  6496. </glossentry>
  6497. <glossentry id='var-LDFLAGS'><glossterm>LDFLAGS</glossterm>
  6498. <info>
  6499. LDFLAGS[doc] = "Specifies the flags to pass to the linker."
  6500. </info>
  6501. <glossdef>
  6502. <para role="glossdeffirst">
  6503. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6504. Specifies the flags to pass to the linker.
  6505. This variable is exported to an environment
  6506. variable and thus made visible to the software being
  6507. built during the compilation step.
  6508. </para>
  6509. <para>
  6510. Default initialization for <filename>LDFLAGS</filename>
  6511. varies depending on what is being built:
  6512. <itemizedlist>
  6513. <listitem><para>
  6514. <link linkend='var-TARGET_LDFLAGS'><filename>TARGET_LDFLAGS</filename></link>
  6515. when building for the target
  6516. </para></listitem>
  6517. <listitem><para>
  6518. <link linkend='var-BUILD_LDFLAGS'><filename>BUILD_LDFLAGS</filename></link>
  6519. when building for the build host (i.e.
  6520. <filename>-native</filename>)
  6521. </para></listitem>
  6522. <listitem><para>
  6523. <link linkend='var-BUILDSDK_LDFLAGS'><filename>BUILDSDK_LDFLAGS</filename></link>
  6524. when building for an SDK (i.e.
  6525. <filename>nativesdk-</filename>)
  6526. </para></listitem>
  6527. </itemizedlist>
  6528. </para>
  6529. </glossdef>
  6530. </glossentry>
  6531. <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm>
  6532. <info>
  6533. LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (.so) that the debian class applies its naming policy to given a recipe that packages multiple libraries."
  6534. </info>
  6535. <glossdef>
  6536. <para role="glossdeffirst">
  6537. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6538. Specifies the lead (or primary) compiled library file
  6539. (<filename>.so</filename>) that the
  6540. <link linkend='ref-classes-debian'><filename>debian</filename></link>
  6541. class applies its naming policy to given a recipe that
  6542. packages multiple libraries.
  6543. </para>
  6544. <para>
  6545. This variable works in conjunction with the
  6546. <filename>debian</filename> class.
  6547. </para>
  6548. </glossdef>
  6549. </glossentry>
  6550. <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm>
  6551. <info>
  6552. LIC_FILES_CHKSUM[doc] = "Checksums of the license text in the recipe source code."
  6553. </info>
  6554. <glossdef>
  6555. <para role="glossdeffirst">
  6556. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6557. Checksums of the license text in the recipe source code.
  6558. </para>
  6559. <para>
  6560. This variable tracks changes in license text of the source
  6561. code files.
  6562. If the license text is changed, it will trigger a build
  6563. failure, which gives the developer an opportunity to review any
  6564. license change.
  6565. </para>
  6566. <para>
  6567. This variable must be defined for all recipes (unless
  6568. <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
  6569. is set to "CLOSED").</para>
  6570. <para>For more information, see the
  6571. "<link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>
  6572. Tracking License Changes</link>" section.
  6573. </para>
  6574. </glossdef>
  6575. </glossentry>
  6576. <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
  6577. <info>
  6578. LICENSE[doc] = "The list of source licenses for the recipe. The logical operators &amp;, '|', and parentheses can be used."
  6579. </info>
  6580. <glossdef>
  6581. <para role="glossdeffirst">
  6582. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6583. The list of source licenses for the recipe.
  6584. Follow these rules:
  6585. <itemizedlist>
  6586. <listitem><para>Do not use spaces within individual
  6587. license names.</para></listitem>
  6588. <listitem><para>Separate license names using
  6589. | (pipe) when there is a choice between licenses.
  6590. </para></listitem>
  6591. <listitem><para>Separate license names using
  6592. &amp; (ampersand) when multiple licenses exist
  6593. that cover different parts of the source.
  6594. </para></listitem>
  6595. <listitem><para>You can use spaces between license
  6596. names.</para></listitem>
  6597. <listitem><para>For standard licenses, use the names
  6598. of the files in
  6599. <filename>meta/files/common-licenses/</filename>
  6600. or the
  6601. <link linkend='var-SPDXLICENSEMAP'><filename>SPDXLICENSEMAP</filename></link>
  6602. flag names defined in
  6603. <filename>meta/conf/licenses.conf</filename>.
  6604. </para></listitem>
  6605. </itemizedlist>
  6606. </para>
  6607. <para>
  6608. Here are some examples:
  6609. <literallayout class='monospaced'>
  6610. LICENSE = "LGPLv2.1 | GPLv3"
  6611. LICENSE = "MPL-1 &amp; LGPLv2.1"
  6612. LICENSE = "GPLv2+"
  6613. </literallayout>
  6614. The first example is from the recipes for Qt, which the user
  6615. may choose to distribute under either the LGPL version
  6616. 2.1 or GPL version 3.
  6617. The second example is from Cairo where two licenses cover
  6618. different parts of the source code.
  6619. The final example is from <filename>sysstat</filename>,
  6620. which presents a single license.
  6621. </para>
  6622. <para>
  6623. You can also specify licenses on a per-package basis to
  6624. handle situations where components of the output have
  6625. different licenses.
  6626. For example, a piece of software whose code is
  6627. licensed under GPLv2 but has accompanying documentation
  6628. licensed under the GNU Free Documentation License 1.2 could
  6629. be specified as follows:
  6630. <literallayout class='monospaced'>
  6631. LICENSE = "GFDL-1.2 &amp; GPLv2"
  6632. LICENSE_${PN} = "GPLv2"
  6633. LICENSE_${PN}-doc = "GFDL-1.2"
  6634. </literallayout>
  6635. </para>
  6636. </glossdef>
  6637. </glossentry>
  6638. <glossentry id='var-LICENSE_CREATE_PACKAGE'><glossterm>LICENSE_CREATE_PACKAGE</glossterm>
  6639. <info>
  6640. LICENSE_CREATE_PACKAGE[doc] = "Creates an extra package (i.e. ${PN}-lic) for each recipe and adds that package to the RRECOMMENDS+${PN}."
  6641. </info>
  6642. <glossdef>
  6643. <para role="glossdeffirst">
  6644. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6645. Setting <filename>LICENSE_CREATE_PACKAGE</filename>
  6646. to "1" causes the OpenEmbedded build system to create
  6647. an extra package (i.e.
  6648. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-lic</filename>)
  6649. for each recipe and to add those packages to the
  6650. <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link><filename>_${PN}</filename>.
  6651. </para>
  6652. <para>
  6653. The <filename>${PN}-lic</filename> package installs a
  6654. directory in <filename>/usr/share/licenses</filename>
  6655. named <filename>${PN}</filename>, which is the recipe's
  6656. base name, and installs files in that directory that
  6657. contain license and copyright information (i.e. copies of
  6658. the appropriate license files from
  6659. <filename>meta/common-licenses</filename> that match the
  6660. licenses specified in the
  6661. <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
  6662. variable of the recipe metadata and copies of files marked
  6663. in
  6664. <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>
  6665. as containing license text).
  6666. </para>
  6667. <para>
  6668. For related information on providing license text, see the
  6669. <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link>
  6670. variable, the
  6671. <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link>
  6672. variable, and the
  6673. "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>"
  6674. section in the Yocto Project Development Manual.
  6675. </para>
  6676. </glossdef>
  6677. </glossentry>
  6678. <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm>
  6679. <info>
  6680. LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built."
  6681. </info>
  6682. <glossdef>
  6683. <para role="glossdeffirst">
  6684. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6685. Specifies additional flags for a recipe you must
  6686. whitelist through
  6687. <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link>
  6688. in order to allow the recipe to be built.
  6689. When providing multiple flags, separate them with
  6690. spaces.
  6691. </para>
  6692. <para>
  6693. This value is independent of
  6694. <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
  6695. and is typically used to mark recipes that might
  6696. require additional licenses in order to be used in a
  6697. commercial product.
  6698. For more information, see the
  6699. "<link linkend='enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</link>"
  6700. section.
  6701. </para>
  6702. </glossdef>
  6703. </glossentry>
  6704. <glossentry id='var-LICENSE_FLAGS_WHITELIST'><glossterm>LICENSE_FLAGS_WHITELIST</glossterm>
  6705. <info>
  6706. LICENSE_FLAGS_WHITELIST[doc] = "Lists license flags that when specified in LICENSE_FLAGS within a recipe should not prevent that recipe from being built."
  6707. </info>
  6708. <glossdef>
  6709. <para role="glossdeffirst">
  6710. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6711. Lists license flags that when specified in
  6712. <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link>
  6713. within a recipe should not prevent that recipe from being
  6714. built.
  6715. This practice is otherwise known as "whitelisting"
  6716. license flags.
  6717. For more information, see the
  6718. <link linkend='enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</link>"
  6719. section.
  6720. </para>
  6721. </glossdef>
  6722. </glossentry>
  6723. <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm>
  6724. <info>
  6725. LICENSE_PATH[doc] = "Path to additional licenses used during the build."
  6726. </info>
  6727. <glossdef>
  6728. <para role="glossdeffirst">
  6729. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6730. Path to additional licenses used during the build.
  6731. By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename>
  6732. to define the directory that holds common license text used during the build.
  6733. The <filename>LICENSE_PATH</filename> variable allows you to extend that
  6734. location to other areas that have additional licenses:
  6735. <literallayout class='monospaced'>
  6736. LICENSE_PATH += "<replaceable>path-to-additional-common-licenses</replaceable>"
  6737. </literallayout>
  6738. </para>
  6739. </glossdef>
  6740. </glossentry>
  6741. <glossentry id='var-LINUX_KERNEL_TYPE'><glossterm>LINUX_KERNEL_TYPE</glossterm>
  6742. <info>
  6743. LINUX_KERNEL_TYPE[doc] = "Defines the kernel type to be used in assembling the configuration."
  6744. </info>
  6745. <glossdef>
  6746. <para role="glossdeffirst">
  6747. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6748. Defines the kernel type to be used in assembling the
  6749. configuration.
  6750. The linux-yocto recipes define "standard", "tiny", and
  6751. "preempt-rt" kernel types.
  6752. See the
  6753. "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>"
  6754. section in the Yocto Project Linux Kernel Development
  6755. Manual for more information on kernel types.
  6756. </para>
  6757. <para>
  6758. If you do not specify a
  6759. <filename>LINUX_KERNEL_TYPE</filename>, it defaults to
  6760. "standard".
  6761. Together with
  6762. <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>,
  6763. the <filename>LINUX_KERNEL_TYPE</filename> variable
  6764. defines the search
  6765. arguments used by the kernel tools to find the appropriate
  6766. description within the kernel
  6767. <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
  6768. with which to build out the sources and configuration.
  6769. </para>
  6770. </glossdef>
  6771. </glossentry>
  6772. <glossentry id='var-LINUX_VERSION'><glossterm>LINUX_VERSION</glossterm>
  6773. <info>
  6774. LINUX_VERSION[doc] = "The Linux version from kernel.org on which the Linux kernel image being built using the OpenEmbedded build system is based. You define this variable in the kernel recipe."
  6775. </info>
  6776. <glossdef>
  6777. <para role="glossdeffirst">
  6778. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6779. The Linux version from <filename>kernel.org</filename>
  6780. on which the Linux kernel image being built using the
  6781. OpenEmbedded build system is based.
  6782. You define this variable in the kernel recipe.
  6783. For example, the <filename>linux-yocto-3.4.bb</filename>
  6784. kernel recipe found in
  6785. <filename>meta/recipes-kernel/linux</filename>
  6786. defines the variables as follows:
  6787. <literallayout class='monospaced'>
  6788. LINUX_VERSION ?= "3.4.24"
  6789. </literallayout>
  6790. </para>
  6791. <para>
  6792. The <filename>LINUX_VERSION</filename> variable is used to
  6793. define <link linkend='var-PV'><filename>PV</filename></link>
  6794. for the recipe:
  6795. <literallayout class='monospaced'>
  6796. PV = "${LINUX_VERSION}+git${SRCPV}"
  6797. </literallayout>
  6798. </para>
  6799. </glossdef>
  6800. </glossentry>
  6801. <glossentry id='var-LINUX_VERSION_EXTENSION'><glossterm>LINUX_VERSION_EXTENSION</glossterm>
  6802. <info>
  6803. LINUX_VERSION_EXTENSION[doc] = "A string extension compiled into the version string of the Linux kernel built with the OpenEmbedded build system. You define this variable in the kernel recipe."
  6804. </info>
  6805. <glossdef>
  6806. <para role="glossdeffirst">
  6807. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6808. A string extension compiled into the version
  6809. string of the Linux kernel built with the OpenEmbedded
  6810. build system.
  6811. You define this variable in the kernel recipe.
  6812. For example, the linux-yocto kernel recipes all define
  6813. the variable as follows:
  6814. <literallayout class='monospaced'>
  6815. LINUX_VERSION_EXTENSION ?= "-yocto-${<link linkend='var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</link>}"
  6816. </literallayout>
  6817. </para>
  6818. <para>
  6819. Defining this variable essentially sets the
  6820. Linux kernel configuration item
  6821. <filename>CONFIG_LOCALVERSION</filename>, which is visible
  6822. through the <filename>uname</filename> command.
  6823. Here is an example that shows the extension assuming it
  6824. was set as previously shown:
  6825. <literallayout class='monospaced'>
  6826. $ uname -r
  6827. 3.7.0-rc8-custom
  6828. </literallayout>
  6829. </para>
  6830. </glossdef>
  6831. </glossentry>
  6832. <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm>
  6833. <info>
  6834. LOG_DIR[doc] = "Specifies the directory to which the OpenEmbedded build system writes overall log files. The default directory is ${TMPDIR}/log"
  6835. </info>
  6836. <glossdef>
  6837. <para role="glossdeffirst">
  6838. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6839. Specifies the directory to which the OpenEmbedded build
  6840. system writes overall log files.
  6841. The default directory is <filename>${TMPDIR}/log</filename>.
  6842. </para>
  6843. <para>
  6844. For the directory containing logs specific to each task,
  6845. see the <link linkend='var-T'><filename>T</filename></link>
  6846. variable.
  6847. </para>
  6848. </glossdef>
  6849. </glossentry>
  6850. </glossdiv>
  6851. <glossdiv id='var-glossary-m'><title>M</title>
  6852. <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
  6853. <info>
  6854. MACHINE[doc] = "Specifies the target device for which the image is built. You define MACHINE in the conf/local.conf file in the Build Directory."
  6855. </info>
  6856. <glossdef>
  6857. <para role="glossdeffirst">
  6858. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6859. Specifies the target device for which the image is built.
  6860. You define <filename>MACHINE</filename> in the
  6861. <filename>local.conf</filename> file found in the
  6862. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  6863. By default, <filename>MACHINE</filename> is set to
  6864. "qemux86", which is an x86-based architecture machine to
  6865. be emulated using QEMU:
  6866. <literallayout class='monospaced'>
  6867. MACHINE ?= "qemux86"
  6868. </literallayout>
  6869. </para>
  6870. <para>
  6871. The variable corresponds to a machine configuration file of the
  6872. same name, through which machine-specific configurations are set.
  6873. Thus, when <filename>MACHINE</filename> is set to "qemux86" there
  6874. exists the corresponding <filename>qemux86.conf</filename> machine
  6875. configuration file, which can be found in the
  6876. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  6877. in <filename>meta/conf/machine</filename>.
  6878. </para>
  6879. <para>
  6880. The list of machines supported by the Yocto Project as
  6881. shipped include the following:
  6882. <literallayout class='monospaced'>
  6883. MACHINE ?= "qemuarm"
  6884. MACHINE ?= "qemuarm64"
  6885. MACHINE ?= "qemumips"
  6886. MACHINE ?= "qemumips64"
  6887. MACHINE ?= "qemuppc"
  6888. MACHINE ?= "qemux86"
  6889. MACHINE ?= "qemux86-64"
  6890. MACHINE ?= "genericx86"
  6891. MACHINE ?= "genericx86-64"
  6892. MACHINE ?= "beaglebone"
  6893. MACHINE ?= "mpc8315e-rdb"
  6894. MACHINE ?= "edgerouter"
  6895. </literallayout>
  6896. The last five are Yocto Project reference hardware boards, which
  6897. are provided in the <filename>meta-yocto-bsp</filename> layer.
  6898. <note>Adding additional Board Support Package (BSP) layers
  6899. to your configuration adds new possible settings for
  6900. <filename>MACHINE</filename>.
  6901. </note>
  6902. </para>
  6903. </glossdef>
  6904. </glossentry>
  6905. <glossentry id='var-MACHINE_ARCH'><glossterm>MACHINE_ARCH</glossterm>
  6906. <info>
  6907. MACHINE_ARCH[doc] = "Specifies the name of the machine-specific architecture. This variable is set automatically from MACHINE or TUNE_PKGARCH."
  6908. </info>
  6909. <glossdef>
  6910. <para role="glossdeffirst">
  6911. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6912. Specifies the name of the machine-specific architecture.
  6913. This variable is set automatically from
  6914. <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
  6915. or
  6916. <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>.
  6917. You should not hand-edit the
  6918. <filename>MACHINE_ARCH</filename> variable.
  6919. </para>
  6920. </glossdef>
  6921. </glossentry>
  6922. <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
  6923. <info>
  6924. MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot."
  6925. </info>
  6926. <glossdef>
  6927. <para role="glossdeffirst">
  6928. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6929. A list of required machine-specific packages to install as part of
  6930. the image being built.
  6931. The build process depends on these packages being present.
  6932. Furthermore, because this is a "machine essential" variable, the list of
  6933. packages are essential for the machine to boot.
  6934. The impact of this variable affects images based on
  6935. <filename>packagegroup-core-boot</filename>,
  6936. including the <filename>core-image-minimal</filename> image.
  6937. </para>
  6938. <para>
  6939. This variable is similar to the
  6940. <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename>
  6941. variable with the exception that the image being built has a build
  6942. dependency on the variable's list of packages.
  6943. In other words, the image will not build if a file in this list is not found.
  6944. </para>
  6945. <para>
  6946. As an example, suppose the machine for which you are building requires
  6947. <filename>example-init</filename> to be run during boot to initialize the hardware.
  6948. In this case, you would use the following in the machine's
  6949. <filename>.conf</filename> configuration file:
  6950. <literallayout class='monospaced'>
  6951. MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init"
  6952. </literallayout>
  6953. </para>
  6954. </glossdef>
  6955. </glossentry>
  6956. <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
  6957. <info>
  6958. MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot."
  6959. </info>
  6960. <glossdef>
  6961. <para role="glossdeffirst">
  6962. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  6963. A list of recommended machine-specific packages to install as part of
  6964. the image being built.
  6965. The build process does not depend on these packages being present.
  6966. However, because this is a "machine essential" variable, the list of
  6967. packages are essential for the machine to boot.
  6968. The impact of this variable affects images based on
  6969. <filename>packagegroup-core-boot</filename>,
  6970. including the <filename>core-image-minimal</filename> image.
  6971. </para>
  6972. <para>
  6973. This variable is similar to the
  6974. <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename>
  6975. variable with the exception that the image being built does not have a build
  6976. dependency on the variable's list of packages.
  6977. In other words, the image will still build if a package in this list is not found.
  6978. Typically, this variable is used to handle essential kernel modules, whose
  6979. functionality may be selected to be built into the kernel rather than as a module,
  6980. in which case a package will not be produced.
  6981. </para>
  6982. <para>
  6983. Consider an example where you have a custom kernel where a specific touchscreen
  6984. driver is required for the machine to be usable.
  6985. However, the driver can be built as a module or
  6986. into the kernel depending on the kernel configuration.
  6987. If the driver is built as a module, you want it to be installed.
  6988. But, when the driver is built into the kernel, you still want the
  6989. build to succeed.
  6990. This variable sets up a "recommends" relationship so that in the latter case,
  6991. the build will not fail due to the missing package.
  6992. To accomplish this, assuming the package for the module was called
  6993. <filename>kernel-module-ab123</filename>, you would use the
  6994. following in the machine's <filename>.conf</filename> configuration
  6995. file:
  6996. <literallayout class='monospaced'>
  6997. MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123"
  6998. </literallayout>
  6999. <note>
  7000. In this example, the
  7001. <filename>kernel-module-ab123</filename> recipe
  7002. needs to explicitly set its
  7003. <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
  7004. variable to ensure that BitBake does not use the
  7005. kernel recipe's
  7006. <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link>
  7007. variable to satisfy the dependency.
  7008. </note>
  7009. </para>
  7010. <para>
  7011. Some examples of these machine essentials are flash, screen, keyboard, mouse,
  7012. or touchscreen drivers (depending on the machine).
  7013. </para>
  7014. </glossdef>
  7015. </glossentry>
  7016. <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
  7017. <info>
  7018. MACHINE_EXTRA_RDEPENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for the machine to boot. However, the build process for more fully-featured images depends on the packages being present."
  7019. </info>
  7020. <glossdef>
  7021. <para role="glossdeffirst">
  7022. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7023. A list of machine-specific packages to install as part of the
  7024. image being built that are not essential for the machine to boot.
  7025. However, the build process for more fully-featured images
  7026. depends on the packages being present.
  7027. </para>
  7028. <para>
  7029. This variable affects all images based on
  7030. <filename>packagegroup-base</filename>, which does not include the
  7031. <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename>
  7032. images.
  7033. </para>
  7034. <para>
  7035. The variable is similar to the
  7036. <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename>
  7037. variable with the exception that the image being built has a build
  7038. dependency on the variable's list of packages.
  7039. In other words, the image will not build if a file in this list is not found.
  7040. </para>
  7041. <para>
  7042. An example is a machine that has WiFi capability but is not
  7043. essential for the machine to boot the image.
  7044. However, if you are building a more fully-featured image, you want to enable
  7045. the WiFi.
  7046. The package containing the firmware for the WiFi hardware is always
  7047. expected to exist, so it is acceptable for the build process to depend upon
  7048. finding the package.
  7049. In this case, assuming the package for the firmware was called
  7050. <filename>wifidriver-firmware</filename>, you would use the following in the
  7051. <filename>.conf</filename> file for the machine:
  7052. <literallayout class='monospaced'>
  7053. MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware"
  7054. </literallayout>
  7055. </para>
  7056. </glossdef>
  7057. </glossentry>
  7058. <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
  7059. <info>
  7060. MACHINE_EXTRA_RRECOMMENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependencies on the packages in this list."
  7061. </info>
  7062. <glossdef>
  7063. <para role="glossdeffirst">
  7064. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7065. A list of machine-specific packages to install as part of the
  7066. image being built that are not essential for booting the machine.
  7067. The image being built has no build dependency on this list of packages.
  7068. </para>
  7069. <para>
  7070. This variable affects only images based on
  7071. <filename>packagegroup-base</filename>, which does not include the
  7072. <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename>
  7073. images.
  7074. </para>
  7075. <para>
  7076. This variable is similar to the
  7077. <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename>
  7078. variable with the exception that the image being built does not have a build
  7079. dependency on the variable's list of packages.
  7080. In other words, the image will build if a file in this list is not found.
  7081. </para>
  7082. <para>
  7083. An example is a machine that has WiFi capability but is not essential
  7084. For the machine to boot the image.
  7085. However, if you are building a more fully-featured image, you want to enable
  7086. WiFi.
  7087. In this case, the package containing the WiFi kernel module will not be produced
  7088. if the WiFi driver is built into the kernel, in which case you still want the
  7089. build to succeed instead of failing as a result of the package not being found.
  7090. To accomplish this, assuming the package for the module was called
  7091. <filename>kernel-module-examplewifi</filename>, you would use the
  7092. following in the <filename>.conf</filename> file for the machine:
  7093. <literallayout class='monospaced'>
  7094. MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi"
  7095. </literallayout>
  7096. </para>
  7097. </glossdef>
  7098. </glossentry>
  7099. <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
  7100. <info>
  7101. MACHINE_FEATURES[doc] = "Specifies the list of hardware features the MACHINE supports."
  7102. </info>
  7103. <glossdef>
  7104. <para role="glossdeffirst">
  7105. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7106. Specifies the list of hardware features the
  7107. <link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable
  7108. of supporting.
  7109. For related information on enabling features, see the
  7110. <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>,
  7111. <link linkend='var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></link>,
  7112. and
  7113. <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
  7114. variables.
  7115. </para>
  7116. <para>
  7117. For a list of hardware features supported by the Yocto
  7118. Project as shipped, see the
  7119. "<link linkend='ref-features-machine'>Machine Features</link>"
  7120. section.
  7121. </para>
  7122. </glossdef>
  7123. </glossentry>
  7124. <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm>
  7125. <info>
  7126. MACHINE_FEATURES_BACKFILL[doc] = "Features to be added to MACHINE_FEATURES if not also present in MACHINE_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and is not intended to be user-configurable."
  7127. </info>
  7128. <glossdef>
  7129. <para role="glossdeffirst">
  7130. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7131. Features to be added to
  7132. <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>
  7133. if not also present in
  7134. <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>.
  7135. </para>
  7136. <para>
  7137. This variable is set in the <filename>meta/conf/bitbake.conf</filename> file.
  7138. It is not intended to be user-configurable.
  7139. It is best to just reference the variable to see which machine features are
  7140. being backfilled for all machine configurations.
  7141. See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for
  7142. more information.
  7143. </para>
  7144. </glossdef>
  7145. </glossentry>
  7146. <glossentry id='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><glossterm>MACHINE_FEATURES_BACKFILL_CONSIDERED</glossterm>
  7147. <info>
  7148. MACHINE_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from MACHINE_FEATURES_BACKFILL that should not be backfilled (i.e. added to MACHINE_FEATURES) during the build."
  7149. </info>
  7150. <glossdef>
  7151. <para role="glossdeffirst">
  7152. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7153. Features from
  7154. <filename><link linkend='var-MACHINE_FEATURES_BACKFILL'>MACHINE_FEATURES_BACKFILL</link></filename>
  7155. that should not be backfilled (i.e. added to
  7156. <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>)
  7157. during the build.
  7158. See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for
  7159. more information.
  7160. </para>
  7161. </glossdef>
  7162. </glossentry>
  7163. <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm>
  7164. <info>
  7165. MACHINEOVERRIDES[doc] = "Lists overrides specific to the current machine. By default, this list includes the value of MACHINE."
  7166. </info>
  7167. <glossdef>
  7168. <para role="glossdeffirst">
  7169. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7170. Lists overrides specific to the current machine.
  7171. By default, this list includes the value
  7172. of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>.
  7173. You can extend the list to apply variable overrides for
  7174. classes of machines.
  7175. For example, all QEMU emulated machines (e.g. qemuarm,
  7176. qemux86, and so forth) include a common file named
  7177. <filename>meta/conf/machine/include/qemu.inc</filename>
  7178. that prepends <filename>MACHINEOVERRIDES</filename> with
  7179. the following variable override:
  7180. <literallayout class='monospaced'>
  7181. MACHINEOVERRIDES =. "qemuall:"
  7182. </literallayout>
  7183. </para>
  7184. <para>
  7185. Applying an override like <filename>qemuall</filename>
  7186. affects all QEMU emulated machines elsewhere.
  7187. Here is an example from the
  7188. <filename>connman-conf</filename> recipe:
  7189. <literallayout class='monospaced'>
  7190. SRC_URI_append_qemuall = "file://wired.config \
  7191. file://wired-setup \
  7192. "
  7193. </literallayout>
  7194. </para>
  7195. </glossdef>
  7196. </glossentry>
  7197. <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm>
  7198. <info>
  7199. MAINTAINER[doc] = "The email address of the distribution maintainer."
  7200. </info>
  7201. <glossdef>
  7202. <para role="glossdeffirst">
  7203. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7204. The email address of the distribution maintainer.
  7205. </para>
  7206. </glossdef>
  7207. </glossentry>
  7208. <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm>
  7209. <info>
  7210. MIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code."
  7211. </info>
  7212. <glossdef>
  7213. <para role="glossdeffirst">
  7214. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7215. Specifies additional paths from which the OpenEmbedded
  7216. build system gets source code.
  7217. When the build system searches for source code, it first
  7218. tries the local download directory.
  7219. If that location fails, the build system tries locations
  7220. defined by
  7221. <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>,
  7222. the upstream source, and then locations specified by
  7223. <filename>MIRRORS</filename> in that order.
  7224. </para>
  7225. <para>
  7226. Assuming your distribution
  7227. (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>)
  7228. is "poky", the default value for
  7229. <filename>MIRRORS</filename> is defined in the
  7230. <filename>conf/distro/poky.conf</filename> file in the
  7231. <filename>meta-poky</filename> Git repository.
  7232. </para>
  7233. </glossdef>
  7234. </glossentry>
  7235. <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm>
  7236. <info>
  7237. MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package, such as a Multilib version."
  7238. </info>
  7239. <glossdef>
  7240. <para role="glossdeffirst">
  7241. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7242. Specifies a prefix has been added to
  7243. <link linkend='var-PN'><filename>PN</filename></link> to create a special version
  7244. of a recipe or package, such as a Multilib version.
  7245. The variable is used in places where the prefix needs to be
  7246. added to or removed from a the name (e.g. the
  7247. <link linkend='var-BPN'><filename>BPN</filename></link> variable).
  7248. <filename>MLPREFIX</filename> gets set when a prefix has been
  7249. added to <filename>PN</filename>.
  7250. </para>
  7251. </glossdef>
  7252. </glossentry>
  7253. <glossentry id='var-module_autoload'><glossterm>module_autoload</glossterm>
  7254. <info>
  7255. module_autoload[doc] = "This variable has been replaced by the KERNEL_MODULE_AUTOLOAD variable. You should replace all occurrences of module_autoload with additions to KERNEL_MODULE_AUTOLOAD."
  7256. </info>
  7257. <glossdef>
  7258. <para role="glossdeffirst">
  7259. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7260. This variable has been replaced by the
  7261. <filename>KERNEL_MODULE_AUTOLOAD</filename> variable.
  7262. You should replace all occurrences of
  7263. <filename>module_autoload</filename> with additions to
  7264. <filename>KERNEL_MODULE_AUTOLOAD</filename>, for example:
  7265. <literallayout class='monospaced'>
  7266. module_autoload_rfcomm = "rfcomm"
  7267. </literallayout>
  7268. </para>
  7269. <para>
  7270. should now be replaced with:
  7271. <literallayout class='monospaced'>
  7272. KERNEL_MODULE_AUTOLOAD += "rfcomm"
  7273. </literallayout>
  7274. See the
  7275. <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
  7276. variable for more information.
  7277. </para>
  7278. </glossdef>
  7279. </glossentry>
  7280. <glossentry id='var-module_conf'><glossterm>module_conf</glossterm>
  7281. <info>
  7282. module_conf[doc] = "Specifies modprobe.d syntax lines for inclusion in the /etc/modprobe.d/modname.conf file."
  7283. </info>
  7284. <glossdef>
  7285. <para role="glossdeffirst">
  7286. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7287. Specifies
  7288. <ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink>
  7289. syntax lines for inclusion in the
  7290. <filename>/etc/modprobe.d/modname.conf</filename> file.
  7291. </para>
  7292. <para>
  7293. You can use this variable anywhere that it can be
  7294. recognized by the kernel recipe or out-of-tree kernel
  7295. module recipe (e.g. a machine configuration file, a
  7296. distribution configuration file, an append file for the
  7297. recipe, or the recipe itself).
  7298. If you use this variable, you must also be sure to list
  7299. the module name in the
  7300. <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
  7301. variable.
  7302. </para>
  7303. <para>
  7304. Here is the general syntax:
  7305. <literallayout class='monospaced'>
  7306. module_conf_<replaceable>module_name</replaceable> = "<replaceable>modprobe.d-syntax</replaceable>"
  7307. </literallayout>
  7308. You must use the kernel module name override.
  7309. </para>
  7310. <para>
  7311. Run <filename>man modprobe.d</filename> in the shell to
  7312. find out more information on the exact syntax
  7313. you want to provide with <filename>module_conf</filename>.
  7314. </para>
  7315. <para>
  7316. Including <filename>module_conf</filename> causes the
  7317. OpenEmbedded build system to populate the
  7318. <filename>/etc/modprobe.d/modname.conf</filename>
  7319. file with <filename>modprobe.d</filename> syntax lines.
  7320. Here is an example that adds the options
  7321. <filename>arg1</filename> and <filename>arg2</filename>
  7322. to a module named <filename>mymodule</filename>:
  7323. <literallayout class='monospaced'>
  7324. module_conf_mymodule = "options mymodule arg1=val1 arg2=val2"
  7325. </literallayout>
  7326. </para>
  7327. <para>
  7328. For information on how to specify kernel modules to
  7329. auto-load on boot, see the
  7330. <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link>
  7331. variable.
  7332. </para>
  7333. </glossdef>
  7334. </glossentry>
  7335. <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm>
  7336. <info>
  7337. MODULE_IMAGE_BASE_NAME[doc] = "The base name of the kernel modules tarball."
  7338. </info>
  7339. <glossdef>
  7340. <para role="glossdeffirst">
  7341. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7342. The base name of the kernel modules tarball.
  7343. This variable is set in the
  7344. <link linkend='ref-classes-kernel'>kernel</link> class
  7345. as follows:
  7346. <literallayout class='monospaced'>
  7347. MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}"
  7348. </literallayout>
  7349. </para>
  7350. <para>
  7351. See the
  7352. <link linkend='var-PKGE'><filename>PKGE</filename></link>,
  7353. <link linkend='var-PKGV'><filename>PKGV</filename></link>,
  7354. <link linkend='var-PKGR'><filename>PKGR</filename></link>,
  7355. <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
  7356. and
  7357. <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
  7358. variables for additional information.
  7359. </para>
  7360. </glossdef>
  7361. </glossentry>
  7362. <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm>
  7363. <info>
  7364. MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation of this file, which contains all of the kernel modules resulting from a kernel build."
  7365. </info>
  7366. <glossdef>
  7367. <para role="glossdeffirst">
  7368. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7369. Controls creation of the <filename>modules-*.tgz</filename>
  7370. file.
  7371. Set this variable to "0" to disable creation of this
  7372. file, which contains all of the kernel modules resulting
  7373. from a kernel build.
  7374. </para>
  7375. </glossdef>
  7376. </glossentry>
  7377. <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm>
  7378. <info>
  7379. MULTIMACH_TARGET_SYS[doc] = "Separates files for different machines such that you can build for multiple target machines using the same output directories."
  7380. </info>
  7381. <glossdef>
  7382. <para role="glossdeffirst">
  7383. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7384. Separates files for different machines such that you can build
  7385. for multiple target machines using the same output directories.
  7386. See the <link linkend='var-STAMP'><filename>STAMP</filename></link> variable
  7387. for an example.
  7388. </para>
  7389. </glossdef>
  7390. </glossentry>
  7391. </glossdiv>
  7392. <glossdiv id='var-glossary-n'><title>N</title>
  7393. <glossentry id='var-NATIVELSBSTRING'><glossterm>NATIVELSBSTRING</glossterm>
  7394. <info>
  7395. NATIVELSBSTRING[doc] = "A string identifying the host distribution."
  7396. </info>
  7397. <glossdef>
  7398. <para role="glossdeffirst">
  7399. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7400. A string identifying the host distribution.
  7401. Strings consist of the host distributor ID
  7402. followed by the release, as reported by the
  7403. <filename>lsb_release</filename> tool
  7404. or as read from <filename>/etc/lsb-release</filename>.
  7405. For example, when running a build on Ubuntu 12.10, the value
  7406. is "Ubuntu-12.10".
  7407. If this information is unable to be determined, the value
  7408. resolves to "Unknown".
  7409. </para>
  7410. <para>
  7411. This variable is used by default to isolate native shared
  7412. state packages for different distributions (e.g. to avoid
  7413. problems with <filename>glibc</filename> version
  7414. incompatibilities).
  7415. Additionally, the variable is checked against
  7416. <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
  7417. if that variable is set.
  7418. </para>
  7419. </glossdef>
  7420. </glossentry>
  7421. <glossentry id='var-NM'><glossterm>NM</glossterm>
  7422. <info>
  7423. NM[doc] = "Minimal command and arguments to run 'nm'."
  7424. </info>
  7425. <glossdef>
  7426. <para role="glossdeffirst">
  7427. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7428. The minimal command and arguments to run
  7429. <filename>nm</filename>.
  7430. </para>
  7431. </glossdef>
  7432. </glossentry>
  7433. <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm>
  7434. <info>
  7435. NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed."
  7436. </info>
  7437. <glossdef>
  7438. <para role="glossdeffirst">
  7439. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7440. Prevents installation of all "recommended-only" packages.
  7441. Recommended-only packages are packages installed only
  7442. through the
  7443. <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
  7444. variable).
  7445. Setting the <filename>NO_RECOMMENDATIONS</filename> variable
  7446. to "1" turns this feature on:
  7447. <literallayout class='monospaced'>
  7448. NO_RECOMMENDATIONS = "1"
  7449. </literallayout>
  7450. </para>
  7451. <para>
  7452. You can set this variable globally in your
  7453. <filename>local.conf</filename> file or you can attach it to
  7454. a specific image recipe by using the recipe name override:
  7455. <literallayout class='monospaced'>
  7456. NO_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>"
  7457. </literallayout>
  7458. </para>
  7459. <para>
  7460. It is important to realize that if you choose to not install
  7461. packages using this variable and some other packages are
  7462. dependent on them (i.e. listed in a recipe's
  7463. <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
  7464. variable), the OpenEmbedded build system ignores your
  7465. request and will install the packages to avoid dependency
  7466. errors.
  7467. <note>
  7468. Some recommended packages might be required for certain
  7469. system functionality, such as kernel modules.
  7470. It is up to you to add packages with the
  7471. <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
  7472. variable.
  7473. </note>
  7474. </para>
  7475. <para>
  7476. Support for this variable exists only when using the
  7477. IPK and RPM packaging backend.
  7478. Support does not exist for DEB.
  7479. </para>
  7480. <para>
  7481. See the
  7482. <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
  7483. and the
  7484. <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
  7485. variables for related information.
  7486. </para>
  7487. </glossdef>
  7488. </glossentry>
  7489. <glossentry id='var-NOHDD'><glossterm>NOHDD</glossterm>
  7490. <info>
  7491. NOHDD[doc] = "Causes the OpenEmbedded build system to skip building the .hddimg image."
  7492. </info>
  7493. <glossdef>
  7494. <para role="glossdeffirst">
  7495. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7496. Causes the OpenEmbedded build system to skip building the
  7497. <filename>.hddimg</filename> image.
  7498. The <filename>NOHDD</filename> variable is used with the
  7499. <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
  7500. class.
  7501. Set the variable to "1" to prevent the
  7502. <filename>.hddimg</filename> image from being built.
  7503. </para>
  7504. </glossdef>
  7505. </glossentry>
  7506. <glossentry id='var-NOISO'><glossterm>NOISO</glossterm>
  7507. <info>
  7508. NOISO[doc] = "Causes the OpenEmbedded build system to skip building the ISO image."
  7509. </info>
  7510. <glossdef>
  7511. <para role="glossdeffirst">
  7512. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7513. Causes the OpenEmbedded build system to skip building the
  7514. ISO image.
  7515. The <filename>NOISO</filename> variable is used with the
  7516. <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
  7517. class.
  7518. Set the variable to "1" to prevent the ISO image from
  7519. being built.
  7520. To enable building an ISO image, set the variable to "0".
  7521. </para>
  7522. </glossdef>
  7523. </glossentry>
  7524. </glossdiv>
  7525. <glossdiv id='var-glossary-o'><title>O</title>
  7526. <glossentry id='var-OBJCOPY'><glossterm>OBJCOPY</glossterm>
  7527. <info>
  7528. OBJCOPY[doc] = "Minimal command and arguments to run 'objcopy'."
  7529. </info>
  7530. <glossdef>
  7531. <para role="glossdeffirst">
  7532. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7533. The minimal command and arguments to run
  7534. <filename>objcopy</filename>.
  7535. </para>
  7536. </glossdef>
  7537. </glossentry>
  7538. <glossentry id='var-OBJDUMP'><glossterm>OBJDUMP</glossterm>
  7539. <info>
  7540. OBJDUMP[doc] = "Minimal command and arguments to run 'objdump'."
  7541. </info>
  7542. <glossdef>
  7543. <para role="glossdeffirst">
  7544. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7545. The minimal command and arguments to run
  7546. <filename>objdump</filename>.
  7547. </para>
  7548. </glossdef>
  7549. </glossentry>
  7550. <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm>
  7551. <info>
  7552. OE_BINCONFIG_EXTRA_MANGLE[doc] = "When a recipe inherits the binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command."
  7553. </info>
  7554. <glossdef>
  7555. <para role="glossdeffirst">
  7556. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7557. When inheriting the
  7558. <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link>
  7559. class, this variable
  7560. specifies additional arguments passed to the "sed" command.
  7561. The sed command alters any paths in configuration scripts
  7562. that have been set up during compilation.
  7563. Inheriting this class results in all paths in these scripts
  7564. being changed to point into the
  7565. <filename>sysroots/</filename> directory so that all builds
  7566. that use the script will use the correct directories
  7567. for the cross compiling layout.
  7568. </para>
  7569. <para>
  7570. See the <filename>meta/classes/binconfig.bbclass</filename>
  7571. in the
  7572. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  7573. for details on how this class applies these additional
  7574. sed command arguments.
  7575. For general information on the
  7576. <filename>binconfig.bbclass</filename> class, see the
  7577. "<link linkend='ref-classes-binconfig'>Binary Configuration Scripts - <filename>binconfig.bbclass</filename></link>"
  7578. section.
  7579. </para>
  7580. </glossdef>
  7581. </glossentry>
  7582. <glossentry id='var-OE_IMPORTS'><glossterm>OE_IMPORTS</glossterm>
  7583. <info>
  7584. OE_IMPORTS[doc] = "An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system."
  7585. </info>
  7586. <glossdef>
  7587. <para role="glossdeffirst">
  7588. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7589. An internal variable used to tell the OpenEmbedded build
  7590. system what Python modules to import for every Python
  7591. function run by the system.
  7592. </para>
  7593. <note>
  7594. Do not set this variable.
  7595. It is for internal use only.
  7596. </note>
  7597. </glossdef>
  7598. </glossentry>
  7599. <glossentry id='var-OE_INIT_ENV_SCRIPT'><glossterm>OE_INIT_ENV_SCRIPT</glossterm>
  7600. <info>
  7601. OE_INIT_ENV_SCRIPT[doc] = "The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK."
  7602. </info>
  7603. <glossdef>
  7604. <para role="glossdeffirst">
  7605. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7606. The name of the build environment setup script for the
  7607. purposes of setting up the environment within the
  7608. extensible SDK.
  7609. The default value is "oe-init-build-env".
  7610. </para>
  7611. <para>
  7612. If you use a custom script to set up your build
  7613. environment, set the
  7614. <filename>OE_INIT_ENV_SCRIPT</filename> variable to its
  7615. name.
  7616. </para>
  7617. </glossdef>
  7618. </glossentry>
  7619. <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm>
  7620. <info>
  7621. OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system."
  7622. </info>
  7623. <glossdef>
  7624. <para role="glossdeffirst">
  7625. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7626. Controls how the OpenEmbedded build system spawns
  7627. interactive terminals on the host development system
  7628. (e.g. using the BitBake command with the
  7629. <filename>-c devshell</filename> command-line option).
  7630. For more information, see the
  7631. "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section
  7632. in the Yocto Project Development Manual.
  7633. </para>
  7634. <para>
  7635. You can use the following values for the
  7636. <filename>OE_TERMINAL</filename> variable:
  7637. <literallayout class='monospaced'>
  7638. auto
  7639. gnome
  7640. xfce
  7641. rxvt
  7642. screen
  7643. konsole
  7644. none
  7645. </literallayout>
  7646. </para>
  7647. </glossdef>
  7648. </glossentry>
  7649. <glossentry id='var-OEROOT'><glossterm>OEROOT</glossterm>
  7650. <info>
  7651. OEROOT[doc] = "The directory from which the top-level build environment setup script is sourced."
  7652. </info>
  7653. <glossdef>
  7654. <para role="glossdeffirst">
  7655. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7656. The directory from which the top-level build environment
  7657. setup script is sourced.
  7658. The Yocto Project makes two top-level build environment
  7659. setup scripts available:
  7660. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
  7661. and
  7662. <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
  7663. When you run one of these scripts, the
  7664. <filename>OEROOT</filename> variable resolves to the
  7665. directory that contains the script.
  7666. </para>
  7667. <para>
  7668. For additional information on how this variable is used,
  7669. see the initialization scripts.
  7670. </para>
  7671. </glossdef>
  7672. </glossentry>
  7673. <glossentry id='var-OLDEST_KERNEL'><glossterm>OLDEST_KERNEL</glossterm>
  7674. <info>
  7675. OLDEST_KERNEL[doc] = "Declares the oldest version of the Linux kernel that the produced binaries must support."
  7676. </info>
  7677. <glossdef>
  7678. <para role="glossdeffirst">
  7679. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7680. Declares the oldest version of the Linux kernel that the
  7681. produced binaries must support.
  7682. This variable is passed into the build of the Embedded
  7683. GNU C Library (<filename>glibc</filename>).
  7684. </para>
  7685. <para>
  7686. The default for this variable comes from the
  7687. <filename>meta/conf/bitbake.conf</filename> configuration
  7688. file.
  7689. You can override this default by setting the variable
  7690. in a custom distribution configuration file.
  7691. </para>
  7692. </glossdef>
  7693. </glossentry>
  7694. <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm>
  7695. <info>
  7696. OVERRIDES[doc] = "BitBake uses OVERRIDES to control what variables are overridden after BitBake parses recipes and configuration files."
  7697. </info>
  7698. <glossdef>
  7699. <para role="glossdeffirst">
  7700. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7701. BitBake uses <filename>OVERRIDES</filename> to control
  7702. what variables are overridden after BitBake parses
  7703. recipes and configuration files.
  7704. You can find more information on how overrides are handled
  7705. in the
  7706. "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>"
  7707. section of the BitBake User Manual.
  7708. </para>
  7709. </glossdef>
  7710. </glossentry>
  7711. </glossdiv>
  7712. <glossdiv id='var-glossary-p'><title>P</title>
  7713. <glossentry id='var-P'><glossterm>P</glossterm>
  7714. <info>
  7715. P[doc] = "The recipe name and version. P is comprised of ${PN}-${PV}."
  7716. </info>
  7717. <glossdef>
  7718. <para role="glossdeffirst">
  7719. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7720. The recipe name and version.
  7721. <filename>P</filename> is comprised of the following:
  7722. <literallayout class='monospaced'>
  7723. ${PN}-${PV}
  7724. </literallayout>
  7725. </para>
  7726. </glossdef>
  7727. </glossentry>
  7728. <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
  7729. <info>
  7730. PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages."
  7731. </info>
  7732. <glossdef>
  7733. <para role="glossdeffirst">
  7734. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7735. The architecture of the resulting package or packages.
  7736. </para>
  7737. <para>
  7738. By default, the value of this variable is set to
  7739. <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>
  7740. when building for the target,
  7741. <filename>BUILD_ARCH</filename> when building for the
  7742. build host and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building
  7743. for the SDK.
  7744. However, if your recipe's output packages are built
  7745. specific to the target machine rather than general for
  7746. the architecture of the machine, you should set
  7747. <filename>PACKAGE_ARCH</filename> to the value of
  7748. <link linkend='var-MACHINE_ARCH'><filename>MACHINE_ARCH</filename></link>
  7749. in the recipe as follows:
  7750. <literallayout class='monospaced'>
  7751. PACKAGE_ARCH = "${MACHINE_ARCH}"
  7752. </literallayout>
  7753. </para>
  7754. </glossdef>
  7755. </glossentry>
  7756. <glossentry id='var-PACKAGE_ARCHS'><glossterm>PACKAGE_ARCHS</glossterm>
  7757. <info>
  7758. PACKAGE_ARCHS[doc] = "A list of architectures compatible with the given target in order of priority."
  7759. </info>
  7760. <glossdef>
  7761. <para role="glossdeffirst">
  7762. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7763. Specifies a list of architectures compatible with
  7764. the target machine.
  7765. This variable is set automatically and should not
  7766. normally be hand-edited.
  7767. Entries are separated using spaces and listed in order
  7768. of priority.
  7769. The default value for
  7770. <filename>PACKAGE_ARCHS</filename> is "all any noarch
  7771. ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}".
  7772. </para>
  7773. </glossdef>
  7774. </glossentry>
  7775. <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm>
  7776. <info>
  7777. PACKAGE_BEFORE_PN[doc] = "Enables easily adding packages to PACKAGES before ${PN} so that the packages can pick up files that would normally be included in the default package."
  7778. </info>
  7779. <glossdef>
  7780. <para role="glossdeffirst">
  7781. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7782. Enables easily adding packages to
  7783. <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
  7784. before <filename>${<link linkend='var-PN'>PN</link>}</filename>
  7785. so that those added packages can pick up files that would normally be
  7786. included in the default package.
  7787. </para>
  7788. </glossdef>
  7789. </glossentry>
  7790. <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
  7791. <info>
  7792. PACKAGE_CLASSES[doc] = "This variable specifies the package manager to use when packaging data. It is set in the conf/local.conf file in the Build Directory."
  7793. </info>
  7794. <glossdef>
  7795. <para role="glossdeffirst">
  7796. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7797. This variable, which is set in the
  7798. <filename>local.conf</filename> configuration file found in
  7799. the <filename>conf</filename> folder of the
  7800. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
  7801. specifies the package manager the OpenEmbedded build system
  7802. uses when packaging data.
  7803. </para>
  7804. <para>
  7805. You can provide one or more of the following arguments for
  7806. the variable:
  7807. <literallayout class='monospaced'>
  7808. PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar"
  7809. </literallayout>
  7810. <note><title>Warning</title>
  7811. While it is a legal option, the
  7812. <filename>package_tar</filename> class is broken
  7813. and is not supported.
  7814. It is recommended that you do not use it.
  7815. </note>
  7816. The build system uses only the first argument in the list
  7817. as the package manager when creating your image or SDK.
  7818. However, packages will be created using any additional
  7819. packaging classes you specify.
  7820. For example, if you use the following in your
  7821. <filename>local.conf</filename> file:
  7822. <literallayout class='monospaced'>
  7823. PACKAGE_CLASSES ?= "package_ipk"
  7824. </literallayout>
  7825. The OpenEmbedded build system uses the IPK package manager
  7826. to create your image or SDK.
  7827. </para>
  7828. <para>
  7829. For information on packaging and build performance effects
  7830. as a result of the package manager in use, see the
  7831. "<link linkend='ref-classes-package'><filename>package.bbclass</filename></link>"
  7832. section.
  7833. </para>
  7834. </glossdef>
  7835. </glossentry>
  7836. <glossentry id='var-PACKAGE_DEBUG_SPLIT_STYLE'><glossterm>PACKAGE_DEBUG_SPLIT_STYLE</glossterm>
  7837. <info>
  7838. PACKAGE_DEBUG_SPLIT_STYLE[doc] = "Determines how to split up the binary and debug information when creating *-dbg packages to be used with the GNU Project Debugger (GDB)."
  7839. </info>
  7840. <glossdef>
  7841. <para role="glossdeffirst">
  7842. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7843. Determines how to split up the binary and debug information
  7844. when creating <filename>*-dbg</filename> packages to be
  7845. used with the GNU Project Debugger (GDB).
  7846. </para>
  7847. <para>
  7848. With the
  7849. <filename>PACKAGE_DEBUG_SPLIT_STYLE</filename> variable,
  7850. you can control where debug information, which can include
  7851. or exclude source files, is stored:
  7852. <itemizedlist>
  7853. <listitem><para>
  7854. ".debug": Debug symbol files are placed next
  7855. to the binary in a <filename>.debug</filename>
  7856. directory on the target.
  7857. For example, if a binary is installed into
  7858. <filename>/bin</filename>, the corresponding debug
  7859. symbol files are installed in
  7860. <filename>/bin/.debug</filename>.
  7861. Source files are placed in
  7862. <filename>/usr/src/debug</filename>.
  7863. This is the default behavior.
  7864. </para></listitem>
  7865. <listitem><para>
  7866. "debug-file-directory": Debug symbol files are
  7867. placed under <filename>/usr/lib/debug</filename>
  7868. on the target, and separated by the path from where
  7869. the binary is installed.
  7870. For example, if a binary is installed in
  7871. <filename>/bin</filename>, the corresponding debug
  7872. symbols are installed in
  7873. <filename>/usr/lib/debug/bin</filename>.
  7874. Source files are placed in
  7875. <filename>/usr/src/debug</filename>.
  7876. </para></listitem>
  7877. <listitem><para>
  7878. "debug-without-src": The same behavior as
  7879. ".debug" previously described with the exception
  7880. that no source files are installed.
  7881. </para></listitem>.
  7882. </itemizedlist>
  7883. </para>
  7884. <para>
  7885. You can find out more about debugging using GDB by reading
  7886. the
  7887. "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
  7888. section in the Yocto Project Development Manual.
  7889. </para>
  7890. </glossdef>
  7891. </glossentry>
  7892. <glossentry id='var-PACKAGE_EXCLUDE_COMPLEMENTARY'><glossterm>PACKAGE_EXCLUDE_COMPLEMENTARY</glossterm>
  7893. <info>
  7894. PACKAGE_EXCLUDE_COMPLEMENTARY[doc] = "Prevents specific packages from being installed when you are installing complementary packages."
  7895. </info>
  7896. <glossdef>
  7897. <para role="glossdeffirst">
  7898. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7899. Prevents specific packages from being installed when
  7900. you are installing complementary packages.
  7901. </para>
  7902. <para>
  7903. You might find that you want to prevent installing certain
  7904. packages when you are installing complementary packages.
  7905. For example, if you are using
  7906. <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
  7907. to install <filename>dev-pkgs</filename>, you might not want
  7908. to install all packages from a particular multilib.
  7909. If you find yourself in this situation, you can use the
  7910. <filename>PACKAGE_EXCLUDE_COMPLEMENTARY</filename> variable
  7911. to specify regular expressions to match the packages you
  7912. want to exclude.
  7913. </para>
  7914. </glossdef>
  7915. </glossentry>
  7916. <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm>
  7917. <info>
  7918. PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed package is required, an error is generated."
  7919. </info>
  7920. <glossdef>
  7921. <para role="glossdeffirst">
  7922. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7923. Lists packages that should not be installed into an image.
  7924. For example:
  7925. <literallayout class='monospaced'>
  7926. PACKAGE_EXCLUDE = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..."
  7927. </literallayout>
  7928. </para>
  7929. <para>
  7930. You can set this variable globally in your
  7931. <filename>local.conf</filename> file or you can attach it to
  7932. a specific image recipe by using the recipe name override:
  7933. <literallayout class='monospaced'>
  7934. PACKAGE_EXCLUDE_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>"
  7935. </literallayout>
  7936. </para>
  7937. <para>
  7938. If you choose to not install
  7939. a package using this variable and some other package is
  7940. dependent on it (i.e. listed in a recipe's
  7941. <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
  7942. variable), the OpenEmbedded build system generates a fatal
  7943. installation error.
  7944. Because the build system halts the process with a fatal
  7945. error, you can use the variable with an iterative
  7946. development process to remove specific components from a
  7947. system.
  7948. </para>
  7949. <para>
  7950. Support for this variable exists only when using the
  7951. IPK and RPM packaging backend.
  7952. Support does not exist for DEB.
  7953. </para>
  7954. <para>
  7955. See the
  7956. <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>
  7957. and the
  7958. <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
  7959. variables for related information.
  7960. </para>
  7961. </glossdef>
  7962. </glossentry>
  7963. <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm>
  7964. <info>
  7965. PACKAGE_EXTRA_ARCHS[doc] = "Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors."
  7966. </info>
  7967. <glossdef>
  7968. <para role="glossdeffirst">
  7969. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7970. Specifies the list of architectures compatible with the device CPU.
  7971. This variable is useful when you build for several different devices that use
  7972. miscellaneous processors such as XScale and ARM926-EJS.
  7973. </para>
  7974. </glossdef>
  7975. </glossentry>
  7976. <glossentry id='var-PACKAGE_FEED_ARCHS'><glossterm>PACKAGE_FEED_ARCHS</glossterm>
  7977. <info>
  7978. PACKAGE_FEED_ARCHS[doc] = "Specifies user-defined package architectures when constructing package feed URIs."
  7979. </info>
  7980. <glossdef>
  7981. <para role="glossdeffirst">
  7982. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  7983. Specifies the package architectures used as part of the
  7984. package feed URIs during the build.
  7985. The <filename>PACKAGE_FEED_ARCHS</filename> variable is
  7986. appended to the final package feed URI, which is constructed
  7987. using the
  7988. <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link>
  7989. and
  7990. <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>
  7991. variables.
  7992. </para>
  7993. <para>
  7994. Consider the following example where the
  7995. <filename>PACKAGE_FEED_URIS</filename>,
  7996. <filename>PACKAGE_FEED_BASE_PATHS</filename>, and
  7997. <filename>PACKAGE_FEED_ARCHS</filename> variables are
  7998. defined in your <filename>local.conf</filename> file:
  7999. <literallayout class='monospaced'>
  8000. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  8001. https://example.com/packagerepos/updates"
  8002. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  8003. PACKAGE_FEED_ARCHS = "all core2-64"
  8004. </literallayout>
  8005. Given these settings, the resulting package feeds are
  8006. as follows:
  8007. <literallayout class='monospaced'>
  8008. https://example.com/packagerepos/release/rpm/all
  8009. https://example.com/packagerepos/release/rpm/core2-64
  8010. https://example.com/packagerepos/release/rpm-dev/all
  8011. https://example.com/packagerepos/release/rpm-dev/core2-64
  8012. https://example.com/packagerepos/updates/rpm/all
  8013. https://example.com/packagerepos/updates/rpm/core2-64
  8014. https://example.com/packagerepos/updates/rpm-dev/all
  8015. https://example.com/packagerepos/updates/rpm-dev/core2-64
  8016. </literallayout>
  8017. </para>
  8018. </glossdef>
  8019. </glossentry>
  8020. <glossentry id='var-PACKAGE_FEED_BASE_PATHS'><glossterm>PACKAGE_FEED_BASE_PATHS</glossterm>
  8021. <info>
  8022. PACKAGE_FEED_BASE_PATHS[doc] = "Specifies base path used when constructing package feed URIs."
  8023. </info>
  8024. <glossdef>
  8025. <para role="glossdeffirst">
  8026. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8027. Specifies the base path used when constructing package feed
  8028. URIs.
  8029. The <filename>PACKAGE_FEED_BASE_PATHS</filename> variable
  8030. makes up the middle portion of a package feed URI used
  8031. by the OpenEmbedded build system.
  8032. The base path lies between the
  8033. <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link>
  8034. and
  8035. <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link>
  8036. variables.
  8037. </para>
  8038. <para>
  8039. Consider the following example where the
  8040. <filename>PACKAGE_FEED_URIS</filename>,
  8041. <filename>PACKAGE_FEED_BASE_PATHS</filename>, and
  8042. <filename>PACKAGE_FEED_ARCHS</filename> variables are
  8043. defined in your <filename>local.conf</filename> file:
  8044. <literallayout class='monospaced'>
  8045. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  8046. https://example.com/packagerepos/updates"
  8047. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  8048. PACKAGE_FEED_ARCHS = "all core2-64"
  8049. </literallayout>
  8050. Given these settings, the resulting package feeds are
  8051. as follows:
  8052. <literallayout class='monospaced'>
  8053. https://example.com/packagerepos/release/rpm/all
  8054. https://example.com/packagerepos/release/rpm/core2-64
  8055. https://example.com/packagerepos/release/rpm-dev/all
  8056. https://example.com/packagerepos/release/rpm-dev/core2-64
  8057. https://example.com/packagerepos/updates/rpm/all
  8058. https://example.com/packagerepos/updates/rpm/core2-64
  8059. https://example.com/packagerepos/updates/rpm-dev/all
  8060. https://example.com/packagerepos/updates/rpm-dev/core2-64
  8061. </literallayout>
  8062. </para>
  8063. </glossdef>
  8064. </glossentry>
  8065. <glossentry id='var-PACKAGE_FEED_URIS'><glossterm>PACKAGE_FEED_URIS</glossterm>
  8066. <info>
  8067. PACKAGE_FEED_URIS[doc] = "Specifies the front portion of the package feed URI used by the OpenEmbedded build system."
  8068. </info>
  8069. <glossdef>
  8070. <para role="glossdeffirst">
  8071. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8072. Specifies the front portion of the package feed URI
  8073. used by the OpenEmbedded build system.
  8074. Each final package feed URI is comprised of
  8075. <filename>PACKAGE_FEED_URIS</filename>,
  8076. <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>,
  8077. and
  8078. <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link>
  8079. variables.
  8080. </para>
  8081. <para>
  8082. Consider the following example where the
  8083. <filename>PACKAGE_FEED_URIS</filename>,
  8084. <filename>PACKAGE_FEED_BASE_PATHS</filename>, and
  8085. <filename>PACKAGE_FEED_ARCHS</filename> variables are
  8086. defined in your <filename>local.conf</filename> file:
  8087. <literallayout class='monospaced'>
  8088. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  8089. https://example.com/packagerepos/updates"
  8090. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  8091. PACKAGE_FEED_ARCHS = "all core2-64"
  8092. </literallayout>
  8093. Given these settings, the resulting package feeds are
  8094. as follows:
  8095. <literallayout class='monospaced'>
  8096. https://example.com/packagerepos/release/rpm/all
  8097. https://example.com/packagerepos/release/rpm/core2-64
  8098. https://example.com/packagerepos/release/rpm-dev/all
  8099. https://example.com/packagerepos/release/rpm-dev/core2-64
  8100. https://example.com/packagerepos/updates/rpm/all
  8101. https://example.com/packagerepos/updates/rpm/core2-64
  8102. https://example.com/packagerepos/updates/rpm-dev/all
  8103. https://example.com/packagerepos/updates/rpm-dev/core2-64
  8104. </literallayout>
  8105. </para>
  8106. </glossdef>
  8107. </glossentry>
  8108. <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
  8109. <info>
  8110. PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES."
  8111. </info>
  8112. <glossdef>
  8113. <para role="glossdeffirst">
  8114. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8115. The <filename>PACKAGE_GROUP</filename> variable has been
  8116. renamed to
  8117. <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>.
  8118. See the variable description for
  8119. <filename>FEATURE_PACKAGES</filename> for information.
  8120. </para>
  8121. <para>
  8122. If if you use the <filename>PACKAGE_GROUP</filename>
  8123. variable, the OpenEmbedded build system issues a warning
  8124. message.
  8125. </para>
  8126. </glossdef>
  8127. </glossentry>
  8128. <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm>
  8129. <info>
  8130. PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list."
  8131. </info>
  8132. <glossdef>
  8133. <para role="glossdeffirst">
  8134. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8135. The final list of packages passed to the package manager
  8136. for installation into the image.
  8137. </para>
  8138. <para>
  8139. Because the package manager controls actual installation
  8140. of all packages, the list of packages passed using
  8141. <filename>PACKAGE_INSTALL</filename> is not the final list
  8142. of packages that are actually installed.
  8143. This variable is internal to the image construction
  8144. code.
  8145. Consequently, in general, you should use the
  8146. <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
  8147. variable to specify packages for installation.
  8148. The exception to this is when working with
  8149. the
  8150. <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link>
  8151. image.
  8152. When working with an initial RAM disk (initramfs)
  8153. image, use the <filename>PACKAGE_INSTALL</filename>
  8154. variable.
  8155. </para>
  8156. </glossdef>
  8157. </glossentry>
  8158. <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm>PACKAGE_INSTALL_ATTEMPTONLY</glossterm>
  8159. <info>
  8160. PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed when creating an image. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined."
  8161. </info>
  8162. <glossdef>
  8163. <para role="glossdeffirst">
  8164. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8165. Specifies a list of packages the OpenEmbedded build
  8166. system attempts to install when creating an image.
  8167. If a listed package fails to install, the build system
  8168. does not generate an error.
  8169. This variable is generally not user-defined.
  8170. </para>
  8171. </glossdef>
  8172. </glossentry>
  8173. <glossentry id='var-PACKAGE_PREPROCESS_FUNCS'><glossterm>PACKAGE_PREPROCESS_FUNCS</glossterm>
  8174. <info>
  8175. PACKAGE_PREPROCESS_FUNCS[doc] = "Specifies a list of functions run to pre-process the PKGD directory prior to splitting the files out to individual packages."
  8176. </info>
  8177. <glossdef>
  8178. <para role="glossdeffirst">
  8179. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8180. Specifies a list of functions run to pre-process the
  8181. <link linkend='var-PKGD'><filename>PKGD</filename></link>
  8182. directory prior to splitting the files out to individual
  8183. packages.
  8184. </para>
  8185. </glossdef>
  8186. </glossentry>
  8187. <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm>
  8188. <info>
  8189. PACKAGECONFIG[doc] = "This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis."
  8190. </info>
  8191. <glossdef>
  8192. <para role="glossdeffirst">
  8193. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8194. This variable provides a means of enabling or disabling
  8195. features of a recipe on a per-recipe basis.
  8196. <filename>PACKAGECONFIG</filename> blocks are defined
  8197. in recipes when you specify features and then arguments
  8198. that define feature behaviors.
  8199. Here is the basic block structure:
  8200. <literallayout class='monospaced'>
  8201. PACKAGECONFIG ??= "f1 f2 f3 ..."
  8202. PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1"
  8203. PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2"
  8204. PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3"
  8205. </literallayout>
  8206. </para>
  8207. <para>
  8208. The <filename>PACKAGECONFIG</filename>
  8209. variable itself specifies a space-separated list of the
  8210. features to enable.
  8211. Following the features, you can determine the behavior of
  8212. each feature by providing up to four order-dependent
  8213. arguments, which are separated by commas.
  8214. You can omit any argument you like but must retain the
  8215. separating commas.
  8216. The order is important and specifies the following:
  8217. <orderedlist>
  8218. <listitem><para>Extra arguments
  8219. that should be added to the configure script
  8220. argument list
  8221. (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>)
  8222. if the feature is enabled.</para></listitem>
  8223. <listitem><para>Extra arguments
  8224. that should be added to <filename>EXTRA_OECONF</filename>
  8225. if the feature is disabled.
  8226. </para></listitem>
  8227. <listitem><para>Additional build dependencies
  8228. (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>)
  8229. that should be added if the feature is enabled.
  8230. </para></listitem>
  8231. <listitem><para>Additional runtime dependencies
  8232. (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
  8233. that should be added if the feature is enabled.
  8234. </para></listitem>
  8235. </orderedlist>
  8236. </para>
  8237. <para>
  8238. Consider the following
  8239. <filename>PACKAGECONFIG</filename> block taken from the
  8240. <filename>librsvg</filename> recipe.
  8241. In this example the feature is <filename>croco</filename>,
  8242. which has three arguments that determine the feature's
  8243. behavior.
  8244. <literallayout class='monospaced'>
  8245. PACKAGECONFIG ??= "croco"
  8246. PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco"
  8247. </literallayout>
  8248. The <filename>--with-croco</filename> and
  8249. <filename>libcroco</filename> arguments apply only if
  8250. the feature is enabled.
  8251. In this case, <filename>--with-croco</filename> is
  8252. added to the configure script argument list and
  8253. <filename>libcroco</filename> is added to
  8254. <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>.
  8255. On the other hand, if the feature is disabled say through
  8256. a <filename>.bbappend</filename> file in another layer, then
  8257. the second argument <filename>--without-croco</filename> is
  8258. added to the configure script rather than
  8259. <filename>--with-croco</filename>.
  8260. </para>
  8261. <para>
  8262. The basic <filename>PACKAGECONFIG</filename> structure
  8263. previously described holds true regardless of whether you
  8264. are creating a block or changing a block.
  8265. When creating a block, use the structure inside your
  8266. recipe.
  8267. </para>
  8268. <para>
  8269. If you want to change an existing
  8270. <filename>PACKAGECONFIG</filename> block, you can do so
  8271. one of two ways:
  8272. <itemizedlist>
  8273. <listitem><para><emphasis>Append file:</emphasis>
  8274. Create an append file named
  8275. <replaceable>recipename</replaceable><filename>.bbappend</filename>
  8276. in your layer and override the value of
  8277. <filename>PACKAGECONFIG</filename>.
  8278. You can either completely override the variable:
  8279. <literallayout class='monospaced'>
  8280. PACKAGECONFIG="f4 f5"
  8281. </literallayout>
  8282. Or, you can just append the variable:
  8283. <literallayout class='monospaced'>
  8284. PACKAGECONFIG_append = " f4"
  8285. </literallayout></para></listitem>
  8286. <listitem><para><emphasis>Configuration file:</emphasis>
  8287. This method is identical to changing the block
  8288. through an append file except you edit your
  8289. <filename>local.conf</filename> or
  8290. <filename><replaceable>mydistro</replaceable>.conf</filename> file.
  8291. As with append files previously described,
  8292. you can either completely override the variable:
  8293. <literallayout class='monospaced'>
  8294. PACKAGECONFIG_pn-<replaceable>recipename</replaceable>="f4 f5"
  8295. </literallayout>
  8296. Or, you can just amend the variable:
  8297. <literallayout class='monospaced'>
  8298. PACKAGECONFIG_append_pn-<replaceable>recipename</replaceable> = " f4"
  8299. </literallayout></para></listitem>
  8300. </itemizedlist>
  8301. </para>
  8302. </glossdef>
  8303. </glossentry>
  8304. <glossentry id='var-PACKAGEGROUP_DISABLE_COMPLEMENTARY'><glossterm>PACKAGEGROUP_DISABLE_COMPLEMENTARY</glossterm>
  8305. <info>
  8306. PACKAGEGROUP_DISABLE_COMPLEMENTARY[doc] = "Prevents automatic creation of the normal complementary packages such as -dev and -dbg in a packagegroup recipe."
  8307. </info>
  8308. <glossdef>
  8309. <para role="glossdeffirst">
  8310. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8311. For recipes inheriting the
  8312. <link linkend='ref-classes-packagegroup'><filename>packagegroup</filename></link>
  8313. class, setting
  8314. <filename>PACKAGEGROUP_DISABLE_COMPLEMENTARY</filename> to
  8315. "1" specifies that the normal complementary packages
  8316. (i.e. <filename>-dev</filename>,
  8317. <filename>-dbg</filename>, and so forth) should not be
  8318. automatically created by the
  8319. <filename>packagegroup</filename> recipe, which is the
  8320. default behavior.
  8321. </para>
  8322. </glossdef>
  8323. </glossentry>
  8324. <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
  8325. <info>
  8326. PACKAGES[doc] = "The list of packages to be created from the recipe."
  8327. </info>
  8328. <glossdef>
  8329. <para role="glossdeffirst">
  8330. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8331. The list of packages to be created from the recipe.
  8332. The default value is the following:
  8333. <literallayout class='monospaced'>
  8334. ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
  8335. </literallayout>
  8336. </para>
  8337. </glossdef>
  8338. </glossentry>
  8339. <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm>
  8340. <info>
  8341. PACKAGES_DYNAMIC[doc] = "A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes."
  8342. </info>
  8343. <glossdef>
  8344. <para role="glossdeffirst">
  8345. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8346. A promise that your recipe satisfies runtime dependencies
  8347. for optional modules that are found in other recipes.
  8348. <filename>PACKAGES_DYNAMIC</filename>
  8349. does not actually satisfy the dependencies, it only states that
  8350. they should be satisfied.
  8351. For example, if a hard, runtime dependency
  8352. (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
  8353. of another package is satisfied
  8354. at build time through the <filename>PACKAGES_DYNAMIC</filename>
  8355. variable, but a package with the module name is never actually
  8356. produced, then the other package will be broken.
  8357. Thus, if you attempt to include that package in an image,
  8358. you will get a dependency failure from the packaging system
  8359. during the
  8360. <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
  8361. task.
  8362. </para>
  8363. <para>
  8364. Typically, if there is a chance that such a situation can
  8365. occur and the package that is not created is valid
  8366. without the dependency being satisfied, then you should use
  8367. <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
  8368. (a soft runtime dependency) instead of
  8369. <filename>RDEPENDS</filename>.
  8370. </para>
  8371. <para>
  8372. For an example of how to use the <filename>PACKAGES_DYNAMIC</filename>
  8373. variable when you are splitting packages, see the
  8374. "<ulink url='&YOCTO_DOCS_DEV_URL;#handling-optional-module-packaging'>Handling Optional Module Packaging</ulink>" section
  8375. in the Yocto Project Development Manual.
  8376. </para>
  8377. </glossdef>
  8378. </glossentry>
  8379. <glossentry id='var-PACKAGESPLITFUNCS'><glossterm>PACKAGESPLITFUNCS</glossterm>
  8380. <info>
  8381. PACKAGESPLITFUNCS[doc] = "Specifies a list of functions run to perform additional splitting of files into individual packages."
  8382. </info>
  8383. <glossdef>
  8384. <para role="glossdeffirst">
  8385. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8386. Specifies a list of functions run to perform additional
  8387. splitting of files into individual packages.
  8388. Recipes can either prepend to this variable or prepend
  8389. to the <filename>populate_packages</filename> function
  8390. in order to perform additional package splitting.
  8391. In either case, the function should set
  8392. <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>,
  8393. <link linkend='var-FILES'><filename>FILES</filename></link>,
  8394. <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
  8395. and other packaging variables appropriately in order to
  8396. perform the desired splitting.
  8397. </para>
  8398. </glossdef>
  8399. </glossentry>
  8400. <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm>
  8401. <info>
  8402. PARALLEL_MAKE[doc] = "Specifies extra options that are passed to the make command during the compile tasks. This variable is usually in the form -j x, where x represents the maximum number of parallel threads make can run."
  8403. </info>
  8404. <glossdef>
  8405. <para role="glossdeffirst">
  8406. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8407. Extra options passed to the <filename>make</filename>
  8408. command during the
  8409. <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>
  8410. task in order to specify parallel compilation on the local
  8411. build host.
  8412. This variable is usually in the form "-j <replaceable>x</replaceable>",
  8413. where <replaceable>x</replaceable> represents the maximum
  8414. number of parallel threads <filename>make</filename> can
  8415. run.
  8416. </para>
  8417. <para>
  8418. By default, the OpenEmbedded build system automatically
  8419. sets this variable to be equal to the number of cores the
  8420. build system uses.
  8421. <note>
  8422. If the software being built experiences dependency
  8423. issues during the <filename>do_compile</filename>
  8424. task that result in race conditions, you can clear
  8425. the <filename>PARALLEL_MAKE</filename> variable within
  8426. the recipe as a workaround.
  8427. For information on addressing race conditions, see the
  8428. "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>"
  8429. section in the Yocto Project Development Manual.
  8430. </note>
  8431. For single socket systems (i.e. one CPU), you should not
  8432. have to override this variable to gain optimal parallelism
  8433. during builds.
  8434. However, if you have very large systems that employ
  8435. multiple physical CPUs, you might want to make sure the
  8436. <filename>PARALLEL_MAKE</filename> variable is not
  8437. set higher than "-j 20".
  8438. </para>
  8439. <para>
  8440. For more information on speeding up builds, see the
  8441. "<link linkend='speeding-up-the-build'>Speeding Up the Build</link>"
  8442. section.
  8443. </para>
  8444. </glossdef>
  8445. </glossentry>
  8446. <glossentry id='var-PARALLEL_MAKEINST'><glossterm>PARALLEL_MAKEINST</glossterm>
  8447. <info>
  8448. PARALLEL_MAKEINST[doc] = "Extra options passed to the make install command during the do_install task in order to specify parallel installation."
  8449. </info>
  8450. <glossdef>
  8451. <para role="glossdeffirst">
  8452. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8453. Extra options passed to the
  8454. <filename>make install</filename> command during the
  8455. <link linkend='ref-tasks-install'><filename>do_install</filename></link>
  8456. task in order to specify parallel installation.
  8457. This variable defaults to the value of
  8458. <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>.
  8459. <note>
  8460. If the software being built experiences dependency
  8461. issues during the
  8462. <filename>do_install</filename> task that result in
  8463. race conditions, you can clear the
  8464. <filename>PARALLEL_MAKEINST</filename> variable within
  8465. the recipe as a workaround.
  8466. For information on addressing race conditions, see the
  8467. "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>"
  8468. section in the Yocto Project Development Manual.
  8469. </note>
  8470. </para>
  8471. </glossdef>
  8472. </glossentry>
  8473. <glossentry id='var-PATCHRESOLVE'><glossterm>PATCHRESOLVE</glossterm>
  8474. <info>
  8475. PATCHRESOLVE[doc] = "Enable or disable interactive patch resolution."
  8476. </info>
  8477. <glossdef>
  8478. <para role="glossdeffirst">
  8479. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8480. Determines the action to take when a patch fails.
  8481. You can set this variable to one of two values: "noop" and
  8482. "user".
  8483. </para>
  8484. <para>
  8485. The default value of "noop" causes the build to simply fail
  8486. when the OpenEmbedded build system cannot successfully
  8487. apply a patch.
  8488. Setting the value to "user" causes the build system to
  8489. launch a shell and places you in the right location so that
  8490. you can manually resolve the conflicts.
  8491. </para>
  8492. <para>
  8493. Set this variable in your
  8494. <filename>local.conf</filename> file.
  8495. </para>
  8496. </glossdef>
  8497. </glossentry>
  8498. <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm>
  8499. <info>
  8500. PATCHTOOL[doc] = "Specifies the utility used to apply patches for a recipe during do_patch."
  8501. </info>
  8502. <glossdef>
  8503. <para role="glossdeffirst">
  8504. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8505. Specifies the utility used to apply patches for a recipe
  8506. during the
  8507. <link linkend='ref-tasks-patch'><filename>do_patch</filename></link>
  8508. task.
  8509. You can specify one of three utilities: "patch", "quilt", or
  8510. "git".
  8511. The default utility used is "quilt" except for the
  8512. quilt-native recipe itself.
  8513. Because the quilt tool is not available at the
  8514. time quilt-native is being patched, it uses "patch".
  8515. </para>
  8516. <para>
  8517. If you wish to use an alternative patching tool, set the
  8518. variable in the recipe using one of the following:
  8519. <literallayout class='monospaced'>
  8520. PATCHTOOL = "patch"
  8521. PATCHTOOL = "quilt"
  8522. PATCHTOOL = "git"
  8523. </literallayout>
  8524. </para>
  8525. </glossdef>
  8526. </glossentry>
  8527. <glossentry id='var-PE'><glossterm>PE</glossterm>
  8528. <info>
  8529. PE[doc] = "The epoch of the recipe. The default value is '0'. The field is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way."
  8530. </info>
  8531. <glossdef>
  8532. <para role="glossdeffirst">
  8533. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8534. The epoch of the recipe.
  8535. By default, this variable is unset.
  8536. The variable is used to make upgrades possible when the
  8537. versioning scheme changes in some backwards incompatible
  8538. way.
  8539. </para>
  8540. </glossdef>
  8541. </glossentry>
  8542. <glossentry id='var-PF'><glossterm>PF</glossterm>
  8543. <info>
  8544. PF[doc] = "Specifies the recipe or package name and includes all version and revision numbers. This variable is comprised of ${PN}-${EXTENDPE}${PV}-${PR}."
  8545. </info>
  8546. <glossdef>
  8547. <para role="glossdeffirst">
  8548. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8549. Specifies the recipe or package name and includes all version and revision
  8550. numbers (i.e. <filename>glibc-2.13-r20+svnr15508/</filename> and
  8551. <filename>bash-4.2-r1/</filename>).
  8552. This variable is comprised of the following:
  8553. <literallayout class='monospaced'>
  8554. ${<link linkend='var-PN'>PN</link>}-${<link linkend='var-EXTENDPE'>EXTENDPE</link>}${<link linkend='var-PV'>PV</link>}-${<link linkend='var-PR'>PR</link>}
  8555. </literallayout>
  8556. </para>
  8557. </glossdef>
  8558. </glossentry>
  8559. <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm>
  8560. <info>
  8561. PIXBUF_PACKAGES[doc] = "When a recipe inherits the pixbufcache class, this variable identifies packages that contain the pixbuf loaders used with gdk-pixbuf."
  8562. </info>
  8563. <glossdef>
  8564. <para role="glossdeffirst">
  8565. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8566. When inheriting the
  8567. <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link>
  8568. class, this variable identifies packages that contain
  8569. the pixbuf loaders used with
  8570. <filename>gdk-pixbuf</filename>.
  8571. By default, the <filename>pixbufcache</filename> class
  8572. assumes that the loaders are in the recipe's main package
  8573. (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
  8574. Use this variable if the loaders you need are in a package
  8575. other than that main package.
  8576. </para>
  8577. </glossdef>
  8578. </glossentry>
  8579. <glossentry id='var-PKG'><glossterm>PKG</glossterm>
  8580. <info>
  8581. PKG[doc] = "The name of the resulting package created by the OpenEmbedded build system. When you use this variable, you must use a package name override."
  8582. </info>
  8583. <glossdef>
  8584. <para role="glossdeffirst">
  8585. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8586. The name of the resulting package created by the
  8587. OpenEmbedded build system.
  8588. <note>
  8589. When using the <filename>PKG</filename> variable, you
  8590. must use a package name override.
  8591. </note>
  8592. </para>
  8593. <para>
  8594. For example, when the
  8595. <link linkend='ref-classes-debian'><filename>debian</filename></link>
  8596. class renames the output package, it does so by setting
  8597. <filename>PKG_<replaceable>packagename</replaceable></filename>.
  8598. </para>
  8599. </glossdef>
  8600. </glossentry>
  8601. <glossentry id='var-PKG_CONFIG_PATH'><glossterm>PKG_CONFIG_PATH</glossterm>
  8602. <info>
  8603. PKG_CONFIG_PATH[doc] = "Path to pkg-config files for the current build context."
  8604. </info>
  8605. <glossdef>
  8606. <para role="glossdeffirst">
  8607. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8608. The path to <filename>pkg-config</filename> files for the
  8609. current build context.
  8610. <filename>pkg-config</filename> reads this variable
  8611. from the environment.
  8612. </para>
  8613. </glossdef>
  8614. </glossentry>
  8615. <glossentry id='var-PKGD'><glossterm>PKGD</glossterm>
  8616. <info>
  8617. PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages."
  8618. </info>
  8619. <glossdef>
  8620. <para role="glossdeffirst">
  8621. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8622. Points to the destination directory for files to be
  8623. packaged before they are split into individual packages.
  8624. This directory defaults to the following:
  8625. <literallayout class='monospaced'>
  8626. ${WORKDIR}/package
  8627. </literallayout>
  8628. </para>
  8629. <para>
  8630. Do not change this default.
  8631. </para>
  8632. </glossdef>
  8633. </glossentry>
  8634. <glossentry id='var-PKGDATA_DIR'><glossterm>PKGDATA_DIR</glossterm>
  8635. <info>
  8636. PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data generated during the packaging process."
  8637. </info>
  8638. <glossdef>
  8639. <para role="glossdeffirst">
  8640. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8641. Points to a shared, global-state directory that holds data
  8642. generated during the packaging process.
  8643. During the packaging process, the
  8644. <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
  8645. task packages data for each recipe and installs it into
  8646. this temporary, shared area.
  8647. This directory defaults to the following:
  8648. <literallayout class='monospaced'>
  8649. ${STAGING_DIR_HOST}/pkgdata
  8650. </literallayout>
  8651. </para>
  8652. <para>
  8653. Do not change this default.
  8654. </para>
  8655. </glossdef>
  8656. </glossentry>
  8657. <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm>
  8658. <info>
  8659. PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split into individual packages."
  8660. </info>
  8661. <glossdef>
  8662. <para role="glossdeffirst">
  8663. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8664. Points to the parent directory for files to be packaged
  8665. after they have been split into individual packages.
  8666. This directory defaults to the following:
  8667. <literallayout class='monospaced'>
  8668. ${WORKDIR}/packages-split
  8669. </literallayout>
  8670. </para>
  8671. <para>
  8672. Under this directory, the build system creates
  8673. directories for each package specified in
  8674. <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>.
  8675. Do not change this default.
  8676. </para>
  8677. </glossdef>
  8678. </glossentry>
  8679. <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm>
  8680. <info>
  8681. PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task."
  8682. </info>
  8683. <glossdef>
  8684. <para role="glossdeffirst">
  8685. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8686. Points to a temporary work area used by the
  8687. <link linkend='ref-tasks-package'><filename>do_package</filename></link>
  8688. task to write output from the
  8689. <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
  8690. task.
  8691. The <filename>PKGDESTWORK</filename> location defaults to
  8692. the following:
  8693. <literallayout class='monospaced'>
  8694. ${WORKDIR}/pkgdata
  8695. </literallayout>
  8696. </para>
  8697. <para>
  8698. The <filename>do_packagedata</filename> task then packages
  8699. the data in the temporary work area and installs it into a
  8700. shared directory pointed to by
  8701. <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>.
  8702. </para>
  8703. <para>
  8704. Do not change this default.
  8705. </para>
  8706. </glossdef>
  8707. </glossentry>
  8708. <glossentry id='var-PKGE'><glossterm>PKGE</glossterm>
  8709. <info>
  8710. PKGE[doc] = "The epoch of the output package built by the OpenEmbedded build system."
  8711. </info>
  8712. <glossdef>
  8713. <para role="glossdeffirst">
  8714. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8715. The epoch of the output package built by the
  8716. OpenEmbedded build system.
  8717. By default, <filename>PKGE</filename> is set to
  8718. <link linkend='var-PE'><filename>PE</filename></link>.
  8719. </para>
  8720. </glossdef>
  8721. </glossentry>
  8722. <glossentry id='var-PKGR'><glossterm>PKGR</glossterm>
  8723. <info>
  8724. PKGR[doc] = "The revision of the output package built by the OpenEmbedded build system."
  8725. </info>
  8726. <glossdef>
  8727. <para role="glossdeffirst">
  8728. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8729. The revision of the output package built by the
  8730. OpenEmbedded build system.
  8731. By default, <filename>PKGR</filename> is set to
  8732. <link linkend='var-PR'><filename>PR</filename></link>.
  8733. </para>
  8734. </glossdef>
  8735. </glossentry>
  8736. <glossentry id='var-PKGV'><glossterm>PKGV</glossterm>
  8737. <info>
  8738. PKGV[doc] = "The version of the output package built by the OpenEmbedded build system."
  8739. </info>
  8740. <glossdef>
  8741. <para role="glossdeffirst">
  8742. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8743. The version of the output package built by the
  8744. OpenEmbedded build system.
  8745. By default, <filename>PKGV</filename> is set to
  8746. <link linkend='var-PV'><filename>PV</filename></link>.
  8747. </para>
  8748. </glossdef>
  8749. </glossentry>
  8750. <glossentry id='var-PN'><glossterm>PN</glossterm>
  8751. <info>
  8752. PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system."
  8753. </info>
  8754. <glossdef>
  8755. <para role="glossdeffirst">
  8756. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8757. This variable can have two separate functions depending on the context: a recipe
  8758. name or a resulting package name.
  8759. </para>
  8760. <para>
  8761. <filename>PN</filename> refers to a recipe name in the context of a file used
  8762. by the OpenEmbedded build system as input to create a package.
  8763. The name is normally extracted from the recipe file name.
  8764. For example, if the recipe is named
  8765. <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename>
  8766. will be "expat".
  8767. </para>
  8768. <para>
  8769. The variable refers to a package name in the context of a file created or produced by the
  8770. OpenEmbedded build system.
  8771. </para>
  8772. <para>
  8773. If applicable, the <filename>PN</filename> variable also contains any special
  8774. suffix or prefix.
  8775. For example, using <filename>bash</filename> to build packages for the native
  8776. machine, <filename>PN</filename> is <filename>bash-native</filename>.
  8777. Using <filename>bash</filename> to build packages for the target and for Multilib,
  8778. <filename>PN</filename> would be <filename>bash</filename> and
  8779. <filename>lib64-bash</filename>, respectively.
  8780. </para>
  8781. </glossdef>
  8782. </glossentry>
  8783. <glossentry id='var-PNBLACKLIST'><glossterm>PNBLACKLIST</glossterm>
  8784. <info>
  8785. PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build."
  8786. </info>
  8787. <glossdef>
  8788. <para role="glossdeffirst">
  8789. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8790. Lists recipes you do not want the OpenEmbedded build system
  8791. to build.
  8792. This variable works in conjunction with the
  8793. <link linkend='ref-classes-blacklist'><filename>blacklist</filename></link>
  8794. class, which the recipe must inherit globally.
  8795. </para>
  8796. <para>
  8797. To prevent a recipe from being built, inherit the class
  8798. globally and use the variable in your
  8799. <filename>local.conf</filename> file.
  8800. Here is an example that prevents
  8801. <filename>myrecipe</filename> from being built:
  8802. <literallayout class='monospaced'>
  8803. INHERIT += "blacklist"
  8804. PNBLACKLIST[myrecipe] = "Not supported by our organization."
  8805. </literallayout>
  8806. </para>
  8807. </glossdef>
  8808. </glossentry>
  8809. <glossentry id='var-POPULATE_SDK_POST_HOST_COMMAND'><glossterm>POPULATE_SDK_POST_HOST_COMMAND</glossterm>
  8810. <info>
  8811. POPULATE_SDK_POST_HOST_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created host part of the SDK."
  8812. </info>
  8813. <glossdef>
  8814. <para role="glossdeffirst">
  8815. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8816. Specifies a list of functions to call once the
  8817. OpenEmbedded build system has created the host part of
  8818. the SDK.
  8819. You can specify functions separated by semicolons:
  8820. <literallayout class='monospaced'>
  8821. POPULATE_SDK_POST_HOST_COMMAND += "<replaceable>function</replaceable>; ... "
  8822. </literallayout>
  8823. </para>
  8824. <para>
  8825. If you need to pass the SDK path to a command
  8826. within a function, you can use
  8827. <filename>${SDK_DIR}</filename>, which points to
  8828. the parent directory used by the OpenEmbedded build
  8829. system when creating SDK output.
  8830. See the
  8831. <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link>
  8832. variable for more information.
  8833. </para>
  8834. </glossdef>
  8835. </glossentry>
  8836. <glossentry id='var-POPULATE_SDK_POST_TARGET_COMMAND'><glossterm>POPULATE_SDK_POST_TARGET_COMMAND</glossterm>
  8837. <info>
  8838. POPULATE_SDK_POST_TARGET_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created target part of the SDK."
  8839. </info>
  8840. <glossdef>
  8841. <para role="glossdeffirst">
  8842. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8843. Specifies a list of functions to call once the
  8844. OpenEmbedded build system has created the target part of
  8845. the SDK.
  8846. You can specify functions separated by semicolons:
  8847. <literallayout class='monospaced'>
  8848. POPULATE_SDK_POST_TARGET_COMMAND += "<replaceable>function</replaceable>; ... "
  8849. </literallayout>
  8850. </para>
  8851. <para>
  8852. If you need to pass the SDK path to a command
  8853. within a function, you can use
  8854. <filename>${SDK_DIR}</filename>, which points to
  8855. the parent directory used by the OpenEmbedded build
  8856. system when creating SDK output.
  8857. See the
  8858. <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link>
  8859. variable for more information.
  8860. </para>
  8861. </glossdef>
  8862. </glossentry>
  8863. <glossentry id='var-PR'><glossterm>PR</glossterm>
  8864. <info>
  8865. PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'."
  8866. </info>
  8867. <glossdef>
  8868. <para role="glossdeffirst">
  8869. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8870. The revision of the recipe. The default value for this
  8871. variable is "r0".
  8872. Subsequent revisions of the recipe conventionally have the
  8873. values "r1", "r2", and so forth.
  8874. When
  8875. <link linkend='var-PV'><filename>PV</filename></link>
  8876. increases, <filename>PR</filename> is conventionally reset
  8877. to "r0".
  8878. <note>
  8879. The OpenEmbedded build system does not need the aid of
  8880. <filename>PR</filename> to know when to rebuild a
  8881. recipe.
  8882. The build system uses
  8883. <link linkend='var-STAMP'><filename>STAMP</filename></link>
  8884. and the
  8885. <link linkend='shared-state-cache'>shared state cache</link>
  8886. mechanisms.
  8887. </note>
  8888. The <filename>PR</filename> variable primarily becomes
  8889. significant when a package manager dynamically installs
  8890. packages on an already built image.
  8891. In this case, <filename>PR</filename>, which is the default
  8892. value of
  8893. <link linkend='var-PKGR'><filename>PKGR</filename></link>,
  8894. helps the package manager distinguish which package is the
  8895. most recent one in cases where many packages have the same
  8896. <filename>PV</filename> (i.e. <filename>PKGV</filename>).
  8897. A component having many packages with the same
  8898. <filename>PV</filename> usually means that the packages all
  8899. install the same upstream version, but with later
  8900. (<filename>PR</filename>) version packages including
  8901. packaging fixes.
  8902. <note>
  8903. <filename>PR</filename> does not need to be increased
  8904. for changes that do not change the package contents or
  8905. metadata.
  8906. </note>
  8907. Because manually managing <filename>PR</filename> can be
  8908. cumbersome and error-prone, an automated solution exists.
  8909. See the
  8910. "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>"
  8911. section for more information.
  8912. </para>
  8913. </glossdef>
  8914. </glossentry>
  8915. <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm>
  8916. <info>
  8917. PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference."
  8918. </info>
  8919. <glossdef>
  8920. <para role="glossdeffirst">
  8921. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8922. If multiple recipes provide an item, this variable
  8923. determines which recipe should be given preference.
  8924. You should always suffix the variable with the name of the
  8925. provided item, and you should set it to the
  8926. <link linkend='var-PN'><filename>PN</filename></link>
  8927. of the recipe to which you want to give precedence.
  8928. Some examples:
  8929. <literallayout class='monospaced'>
  8930. PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
  8931. PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
  8932. PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
  8933. </literallayout>
  8934. <note>
  8935. If you set <filename>PREFERRED_PROVIDER</filename>
  8936. for a <filename>virtual/*</filename> item, then any
  8937. recipe that
  8938. <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
  8939. that item that is not selected by
  8940. <filename>PREFERRED_PROVIDER</filename> is prevented
  8941. from building, which is usually desirable since this
  8942. mechanism is designed to select between mutually
  8943. exclusive alternative providers.
  8944. </note>
  8945. </para>
  8946. </glossdef>
  8947. </glossentry>
  8948. <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm>
  8949. <info>
  8950. PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference."
  8951. </info>
  8952. <glossdef>
  8953. <para role="glossdeffirst">
  8954. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8955. If there are multiple versions of recipes available, this
  8956. variable determines which recipe should be given preference.
  8957. You must always suffix the variable with the
  8958. <link linkend='var-PN'><filename>PN</filename></link>
  8959. you want to select, and you should set the
  8960. <link linkend='var-PV'><filename>PV</filename></link>
  8961. accordingly for precedence.
  8962. You can use the "<filename>%</filename>" character as a
  8963. wildcard to match any number of characters, which can be
  8964. useful when specifying versions that contain long revision
  8965. numbers that could potentially change.
  8966. Here are two examples:
  8967. <literallayout class='monospaced'>
  8968. PREFERRED_VERSION_python = "2.7.3"
  8969. PREFERRED_VERSION_linux-yocto = "3.19%"
  8970. </literallayout>
  8971. Sometimes the <filename>PREFERRED_VERSION</filename>
  8972. variable can be set by configuration files in a way that
  8973. is hard to change.
  8974. You can use
  8975. <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
  8976. to set a machine-specific override.
  8977. Here is an example:
  8978. <literallayout class='monospaced'>
  8979. PREFERRED_VERSION_linux-yocto_qemux86 = "3.4%"
  8980. </literallayout>
  8981. Although not recommended, worst case, you can also use the
  8982. "forcevariable" override, which is the strongest override
  8983. possible.
  8984. Here is an example:
  8985. <literallayout class='monospaced'>
  8986. PREFERRED_VERSION_linux-yocto_forcevariable = "3.4%"
  8987. </literallayout>
  8988. </para>
  8989. </glossdef>
  8990. </glossentry>
  8991. <glossentry id='var-PREMIRRORS'><glossterm>PREMIRRORS</glossterm>
  8992. <info>
  8993. PREMIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code."
  8994. </info>
  8995. <glossdef>
  8996. <para role="glossdeffirst">
  8997. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  8998. Specifies additional paths from which the OpenEmbedded
  8999. build system gets source code.
  9000. When the build system searches for source code, it first
  9001. tries the local download directory.
  9002. If that location fails, the build system tries locations
  9003. defined by <filename>PREMIRRORS</filename>, the upstream
  9004. source, and then locations specified by
  9005. <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
  9006. in that order.
  9007. </para>
  9008. <para>
  9009. Assuming your distribution
  9010. (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>)
  9011. is "poky", the default value for
  9012. <filename>PREMIRRORS</filename> is defined in the
  9013. <filename>conf/distro/poky.conf</filename> file in the
  9014. <filename>meta-poky</filename> Git repository.
  9015. </para>
  9016. <para>
  9017. Typically, you could add a specific server for the
  9018. build system to attempt before any others by adding
  9019. something like the following to the
  9020. <filename>local.conf</filename> configuration file in the
  9021. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
  9022. <literallayout class='monospaced'>
  9023. PREMIRRORS_prepend = "\
  9024. git://.*/.* http://www.yoctoproject.org/sources/ \n \
  9025. ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
  9026. http://.*/.* http://www.yoctoproject.org/sources/ \n \
  9027. https://.*/.* http://www.yoctoproject.org/sources/ \n"
  9028. </literallayout>
  9029. These changes cause the build system to intercept
  9030. Git, FTP, HTTP, and HTTPS requests and direct them to
  9031. the <filename>http://</filename> sources mirror.
  9032. You can use <filename>file://</filename> URLs to point
  9033. to local directories or network shares as well.
  9034. </para>
  9035. </glossdef>
  9036. </glossentry>
  9037. <glossentry id='var-PRIORITY'><glossterm>PRIORITY</glossterm>
  9038. <info>
  9039. PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard' and 'extra'."
  9040. </info>
  9041. <glossdef>
  9042. <para role="glossdeffirst">
  9043. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9044. Indicates the importance of a package.
  9045. </para>
  9046. <para>
  9047. <filename>PRIORITY</filename> is considered to be part of
  9048. the distribution policy because the importance of any given
  9049. recipe depends on the purpose for which the distribution
  9050. is being produced.
  9051. Thus, <filename>PRIORITY</filename> is not normally set
  9052. within recipes.
  9053. </para>
  9054. <para>
  9055. You can set <filename>PRIORITY</filename> to "required",
  9056. "standard", "extra", and "optional", which is the default.
  9057. </para>
  9058. </glossdef>
  9059. </glossentry>
  9060. <glossentry id='var-PRIVATE_LIBS'><glossterm>PRIVATE_LIBS</glossterm>
  9061. <info>
  9062. PRIVATE_LIBS[doc] = "Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver."
  9063. </info>
  9064. <glossdef>
  9065. <para role="glossdeffirst">
  9066. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9067. Specifies libraries installed within a recipe that
  9068. should be ignored by the OpenEmbedded build system's
  9069. shared library resolver.
  9070. This variable is typically used when software being
  9071. built by a recipe has its own private versions of a
  9072. library normally provided by another recipe.
  9073. In this case, you would not want the package containing
  9074. the private libraries to be set as a dependency on other
  9075. unrelated packages that should instead depend on the
  9076. package providing the standard version of the library.
  9077. </para>
  9078. <para>
  9079. Libraries specified in this variable should be specified
  9080. by their file name.
  9081. For example, from the Firefox recipe in meta-browser:
  9082. <literallayout class='monospaced'>
  9083. PRIVATE_LIBS = "libmozjs.so \
  9084. libxpcom.so \
  9085. libnspr4.so \
  9086. libxul.so \
  9087. libmozalloc.so \
  9088. libplc4.so \
  9089. libplds4.so"
  9090. </literallayout>
  9091. </para>
  9092. </glossdef>
  9093. </glossentry>
  9094. <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
  9095. <info>
  9096. PROVIDES[doc] = "A list of aliases that a recipe also provides. These aliases are useful for satisfying dependencies of other recipes during the build as specified by DEPENDS."
  9097. </info>
  9098. <glossdef>
  9099. <para role="glossdeffirst">
  9100. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9101. A list of aliases by which a particular recipe can be
  9102. known.
  9103. By default, a recipe's own
  9104. <filename><link linkend='var-PN'>PN</link></filename>
  9105. is implicitly already in its <filename>PROVIDES</filename>
  9106. list.
  9107. If a recipe uses <filename>PROVIDES</filename>, the
  9108. additional aliases are synonyms for the recipe and can
  9109. be useful satisfying dependencies of other recipes during
  9110. the build as specified by
  9111. <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>.
  9112. </para>
  9113. <para>
  9114. Consider the following example
  9115. <filename>PROVIDES</filename> statement from a recipe
  9116. file <filename>libav_0.8.11.bb</filename>:
  9117. <literallayout class='monospaced'>
  9118. PROVIDES += "libpostproc"
  9119. </literallayout>
  9120. The <filename>PROVIDES</filename> statement results in
  9121. the "libav" recipe also being known as "libpostproc".
  9122. </para>
  9123. </glossdef>
  9124. </glossentry>
  9125. <glossentry id='var-PRSERV_HOST'><glossterm>PRSERV_HOST</glossterm>
  9126. <info>
  9127. PRSERV_HOST[doc] = "The network based PR service host and port."
  9128. </info>
  9129. <glossdef>
  9130. <para role="glossdeffirst">
  9131. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9132. The network based
  9133. <link linkend='var-PR'><filename>PR</filename></link>
  9134. service host and port.
  9135. </para>
  9136. <para>
  9137. The <filename>conf/local.conf.sample.extended</filename>
  9138. configuration file in the
  9139. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  9140. shows how the <filename>PRSERV_HOST</filename> variable is
  9141. set:
  9142. <literallayout class='monospaced'>
  9143. PRSERV_HOST = "localhost:0"
  9144. </literallayout>
  9145. You must set the variable if you want to automatically
  9146. start a local
  9147. <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>.
  9148. You can set <filename>PRSERV_HOST</filename> to other
  9149. values to use a remote PR service.
  9150. </para>
  9151. </glossdef>
  9152. </glossentry>
  9153. <glossentry id='var-PTEST_ENABLED'><glossterm>PTEST_ENABLED</glossterm>
  9154. <info>
  9155. PRSERV_HOST[doc] = "Specifies whether or not Package Test (ptest) functionality is enabled when building a recipe."
  9156. </info>
  9157. <glossdef>
  9158. <para role="glossdeffirst">
  9159. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9160. Specifies whether or not
  9161. <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Package Test</ulink>
  9162. (ptest) functionality is enabled when building a recipe.
  9163. You should not set this variable directly.
  9164. Enabling and disabling building Package Tests
  9165. at build time should be done by adding "ptest" to (or
  9166. removing it from)
  9167. <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
  9168. </para>
  9169. </glossdef>
  9170. </glossentry>
  9171. <glossentry id='var-PV'><glossterm>PV</glossterm>
  9172. <info>
  9173. PV[doc] = "The version of the recipe. The version is normally extracted from the recipe filename."
  9174. </info>
  9175. <glossdef>
  9176. <para role="glossdeffirst">
  9177. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9178. The version of the recipe.
  9179. The version is normally extracted from the recipe filename.
  9180. For example, if the recipe is named
  9181. <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename>
  9182. will be "2.0.1".
  9183. <filename>PV</filename> is generally not overridden within
  9184. a recipe unless it is building an unstable (i.e. development) version from a source code repository
  9185. (e.g. Git or Subversion).
  9186. </para>
  9187. </glossdef>
  9188. </glossentry>
  9189. <glossentry id='var-PYTHON_ABI'><glossterm>PYTHON_ABI</glossterm>
  9190. <info>
  9191. PYTHON_ABI[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, denotes the Application Binary Interface (ABI) currently in use for Python."
  9192. </info>
  9193. <glossdef>
  9194. <para role="glossdeffirst">
  9195. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9196. When used by recipes that inherit the
  9197. <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>,
  9198. <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>,
  9199. <link linkend='ref-classes-distutils'><filename>distutils</filename></link>,
  9200. or
  9201. <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link>
  9202. classes, denotes the Application Binary Interface (ABI)
  9203. currently in use for Python.
  9204. By default, the ABI is "m".
  9205. You do not have to set this variable as the OpenEmbedded
  9206. build system sets it for you.
  9207. </para>
  9208. <para>
  9209. The OpenEmbedded build system uses the ABI to construct
  9210. directory names used when installing the Python headers
  9211. and libraries in sysroot
  9212. (e.g. <filename>.../python3.3m/...</filename>).
  9213. </para>
  9214. <para>
  9215. Recipes that inherit the
  9216. <link linkend='ref-classes-distutils'><filename>distutils</filename></link>
  9217. class during cross-builds also use this variable to
  9218. locate the headers and libraries of the appropriate Python
  9219. that the extension is targeting.
  9220. </para>
  9221. </glossdef>
  9222. </glossentry>
  9223. <glossentry id='var-PYTHON_PN'><glossterm>PYTHON_PN</glossterm>
  9224. <info>
  9225. PYTHON_PN[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, specifies the major Python version being built."
  9226. </info>
  9227. <glossdef>
  9228. <para role="glossdeffirst">
  9229. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9230. When used by recipes that inherit the
  9231. <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>,
  9232. <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>,
  9233. <link linkend='ref-classes-distutils'><filename>distutils</filename></link>,
  9234. or
  9235. <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link>
  9236. classes, specifies the major Python version being built.
  9237. For Python 2.x, <filename>PYTHON_PN</filename> would
  9238. be "python2". For Python 3.x, the variable would be
  9239. "python3".
  9240. You do not have to set this variable as the
  9241. OpenEmbedded build system automatically sets it for you.
  9242. </para>
  9243. <para>
  9244. The variable allows recipes to use common infrastructure
  9245. such as the following:
  9246. <literallayout class='monospaced'>
  9247. DEPENDS += "${PYTHON_PN}-native"
  9248. </literallayout>
  9249. In the previous example, the version of the dependency
  9250. is <filename>PYTHON_PN</filename>.
  9251. </para>
  9252. </glossdef>
  9253. </glossentry>
  9254. </glossdiv>
  9255. <glossdiv id='var-glossary-r'><title>R</title>
  9256. <glossentry id='var-RANLIB'><glossterm>RANLIB</glossterm>
  9257. <info>
  9258. RANLIB[doc] = "Minimal command and arguments to run 'ranlib'."
  9259. </info>
  9260. <glossdef>
  9261. <para role="glossdeffirst">
  9262. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9263. The minimal command and arguments to run
  9264. <filename>ranlib</filename>.
  9265. </para>
  9266. </glossdef>
  9267. </glossentry>
  9268. <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
  9269. <info>
  9270. RCONFLICTS[doc] = "The list of packages that conflict with another package. Note that the package will not be installed if the conflicting packages are not first removed."
  9271. </info>
  9272. <glossdef>
  9273. <para role="glossdeffirst">
  9274. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9275. The list of packages that conflict with packages.
  9276. Note that packages will not be installed if conflicting
  9277. packages are not first removed.
  9278. </para>
  9279. <para>
  9280. Like all package-controlling variables, you must always use
  9281. them in conjunction with a package name override.
  9282. Here is an example:
  9283. <literallayout class='monospaced'>
  9284. RCONFLICTS_${PN} = "<replaceable>another_conflicting_package_name</replaceable>"
  9285. </literallayout>
  9286. </para>
  9287. <para>
  9288. BitBake, which the OpenEmbedded build system uses, supports
  9289. specifying versioned dependencies.
  9290. Although the syntax varies depending on the packaging
  9291. format, BitBake hides these differences from you.
  9292. Here is the general syntax to specify versions with
  9293. the <filename>RCONFLICTS</filename> variable:
  9294. <literallayout class='monospaced'>
  9295. RCONFLICTS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
  9296. </literallayout>
  9297. For <filename>operator</filename>, you can specify the
  9298. following:
  9299. <literallayout class='monospaced'>
  9300. =
  9301. &lt;
  9302. &gt;
  9303. &lt;=
  9304. &gt;=
  9305. </literallayout>
  9306. For example, the following sets up a dependency on version
  9307. 1.2 or greater of the package <filename>foo</filename>:
  9308. <literallayout class='monospaced'>
  9309. RCONFLICTS_${PN} = "foo (>= 1.2)"
  9310. </literallayout>
  9311. </para>
  9312. </glossdef>
  9313. </glossentry>
  9314. <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm>
  9315. <info>
  9316. RDEPENDS[doc] = "Lists a package's runtime dependencies (i.e. other packages) that must be installed for the package to be built. They must be the names of other packages as listed in the PACKAGES variable, not recipe names (PN)."
  9317. </info>
  9318. <glossdef>
  9319. <para role="glossdeffirst">
  9320. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9321. Lists a package's runtime dependencies (i.e. other packages)
  9322. that must be installed in order for the built package to run
  9323. correctly.
  9324. If a package in this list cannot be found during the build,
  9325. you will get a build error.
  9326. </para>
  9327. <para>
  9328. When you use the <filename>RDEPENDS</filename> variable
  9329. in a recipe, you are essentially stating that the recipe's
  9330. <link linkend='ref-tasks-build'><filename>do_build</filename></link>
  9331. task depends on the existence of a specific package.
  9332. Consider this simple example for two recipes named "a" and
  9333. "b" that produce similarly named IPK packages.
  9334. In this example, the <filename>RDEPENDS</filename>
  9335. statement appears in the "a" recipe:
  9336. <literallayout class='monospaced'>
  9337. RDEPENDS_${PN} = "b"
  9338. </literallayout>
  9339. Here, the dependency is such that the
  9340. <filename>do_build</filename> task for recipe "a" depends
  9341. on the
  9342. <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>
  9343. task of recipe "b".
  9344. This means the package file for "b" must be available when
  9345. the output for recipe "a" has been completely built.
  9346. More importantly, package "a" will be marked as depending
  9347. on package "b" in a manner that is understood by the
  9348. package manager.
  9349. </para>
  9350. <para>
  9351. The names of the packages you list within
  9352. <filename>RDEPENDS</filename> must be the names of other
  9353. packages - they cannot be recipe names.
  9354. Although package names and recipe names usually match,
  9355. the important point here is that you are
  9356. providing package names within the
  9357. <filename>RDEPENDS</filename> variable.
  9358. For an example of the default list of packages created from
  9359. a recipe, see the
  9360. <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
  9361. variable.
  9362. </para>
  9363. <para>
  9364. Because the <filename>RDEPENDS</filename> variable applies
  9365. to packages being built, you should always use the variable
  9366. in a form with an attached package name.
  9367. For example, suppose you are building a development package
  9368. that depends on the <filename>perl</filename> package.
  9369. In this case, you would use the following
  9370. <filename>RDEPENDS</filename> statement:
  9371. <literallayout class='monospaced'>
  9372. RDEPENDS_${PN}-dev += "perl"
  9373. </literallayout>
  9374. In the example, the development package depends on
  9375. the <filename>perl</filename> package.
  9376. Thus, the <filename>RDEPENDS</filename> variable has the
  9377. <filename>${PN}-dev</filename> package name as part of the
  9378. variable.
  9379. </para>
  9380. <para>
  9381. The package name you attach to the
  9382. <filename>RDEPENDS</filename> variable must appear
  9383. as it would in the <filename>PACKAGES</filename>
  9384. namespace before any renaming of the output package by
  9385. classes like
  9386. <link linkend='ref-classes-debian'><filename>debian</filename></link>.
  9387. </para>
  9388. <para>
  9389. In many cases you do not need to explicitly add
  9390. runtime dependencies using
  9391. <filename>RDEPENDS</filename> since some automatic
  9392. handling occurs:
  9393. <itemizedlist>
  9394. <listitem><para><emphasis><filename>shlibdeps</filename></emphasis>:
  9395. If a runtime package contains a compiled binary,
  9396. the build processes the binary in order to
  9397. determine any shared libraries
  9398. (<filename>.so</filename> files) to which it is
  9399. dynamically linked.
  9400. The build process adds the packages containing
  9401. these libraries to <filename>RDEPENDS</filename>
  9402. when creating the runtime package.
  9403. In addition, if the shared library is versioned,
  9404. the dependency will have the version appended to it
  9405. in order to force an upgrade to the appropriate
  9406. version if needed.
  9407. </para></listitem>
  9408. <listitem><para><emphasis><filename>pcdeps</filename></emphasis>: If
  9409. the package ships a <filename>pkg-config</filename>
  9410. information file, the build process uses this file
  9411. to add items to the <filename>RDEPENDS</filename>
  9412. variable to create the runtime packages.
  9413. </para></listitem>
  9414. </itemizedlist>
  9415. </para>
  9416. <para>
  9417. BitBake, which the OpenEmbedded build system uses, supports
  9418. specifying versioned dependencies.
  9419. Although the syntax varies depending on the packaging
  9420. format, BitBake hides these differences from you.
  9421. Here is the general syntax to specify versions with
  9422. the <filename>RDEPENDS</filename> variable:
  9423. <literallayout class='monospaced'>
  9424. RDEPENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
  9425. </literallayout>
  9426. For <filename>operator</filename>, you can specify the
  9427. following:
  9428. <literallayout class='monospaced'>
  9429. =
  9430. &lt;
  9431. &gt;
  9432. &lt;=
  9433. &gt;=
  9434. </literallayout>
  9435. For example, the following sets up a dependency on version
  9436. 1.2 or greater of the package <filename>foo</filename>:
  9437. <literallayout class='monospaced'>
  9438. RDEPENDS_${PN} = "foo (>= 1.2)"
  9439. </literallayout>
  9440. </para>
  9441. <para>
  9442. For information on build-time dependencies, see the
  9443. <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
  9444. variable.
  9445. </para>
  9446. </glossdef>
  9447. </glossentry>
  9448. <glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm>
  9449. <info>
  9450. REQUIRED_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe."
  9451. </info>
  9452. <glossdef>
  9453. <para role="glossdeffirst">
  9454. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9455. When inheriting the
  9456. <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link>
  9457. class, this
  9458. variable identifies distribution features that must
  9459. exist in the current configuration in order for the
  9460. OpenEmbedded build system to build the recipe.
  9461. In other words, if the
  9462. <filename>REQUIRED_DISTRO_FEATURES</filename> variable
  9463. lists a feature that does not appear in
  9464. <filename>DISTRO_FEATURES</filename> within the
  9465. current configuration, an error occurs and the
  9466. build stops.
  9467. </para>
  9468. </glossdef>
  9469. </glossentry>
  9470. <glossentry id='var-RM_OLD_IMAGE'><glossterm>RM_OLD_IMAGE</glossterm>
  9471. <info>
  9472. RM_OLD_IMAGE[doc] = "Reclaims disk space by removing previously built versions of the same image from the images directory pointed to by the DEPLOY_DIR variable."
  9473. </info>
  9474. <glossdef>
  9475. <para role="glossdeffirst">
  9476. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9477. Reclaims disk space by removing previously built
  9478. versions of the same image from the
  9479. <filename>images</filename> directory pointed to by the
  9480. <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>
  9481. variable.
  9482. </para>
  9483. <para>
  9484. Set this variable to "1" in your
  9485. <filename>local.conf</filename> file to remove these
  9486. images.
  9487. </para>
  9488. </glossdef>
  9489. </glossentry>
  9490. <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm>
  9491. <info>
  9492. RM_WORK_EXCLUDE[doc] = "With rm_work enabled, this variable specifies a list of packages whose work directories should not be removed."
  9493. </info>
  9494. <glossdef>
  9495. <para role="glossdeffirst">
  9496. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9497. With <filename>rm_work</filename> enabled, this
  9498. variable specifies a list of recipes whose work directories
  9499. should not be removed.
  9500. See the "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>"
  9501. section for more details.
  9502. </para>
  9503. </glossdef>
  9504. </glossentry>
  9505. <glossentry id='var-ROOT_HOME'><glossterm>ROOT_HOME</glossterm>
  9506. <info>
  9507. ROOT_HOME[doc] = "Defines the root home directory."
  9508. </info>
  9509. <glossdef>
  9510. <para role="glossdeffirst">
  9511. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9512. Defines the root home directory.
  9513. By default, this directory is set as follows in the
  9514. BitBake configuration file:
  9515. <literallayout class='monospaced'>
  9516. ROOT_HOME ??= "/home/root"
  9517. </literallayout>
  9518. <note>
  9519. This default value is likely used because some
  9520. embedded solutions prefer to have a read-only root
  9521. filesystem and prefer to keep writeable data in one
  9522. place.
  9523. </note>
  9524. </para>
  9525. <para>
  9526. You can override the default by setting the variable
  9527. in any layer or in the <filename>local.conf</filename> file.
  9528. Because the default is set using a "weak" assignment
  9529. (i.e. "??="), you can use either of the following forms
  9530. to define your override:
  9531. <literallayout class='monospaced'>
  9532. ROOT_HOME = "/root"
  9533. ROOT_HOME ?= "/root"
  9534. </literallayout>
  9535. These override examples use <filename>/root</filename>,
  9536. which is probably the most commonly used override.
  9537. </para>
  9538. </glossdef>
  9539. </glossentry>
  9540. <glossentry id='var-ROOTFS'><glossterm>ROOTFS</glossterm>
  9541. <info>
  9542. ROOTFS[doc] = "Indicates a filesystem image to include as the root filesystem."
  9543. </info>
  9544. <glossdef>
  9545. <para role="glossdeffirst">
  9546. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9547. Indicates a filesystem image to include as the root
  9548. filesystem.
  9549. </para>
  9550. <para>
  9551. The <filename>ROOTFS</filename> variable is an optional
  9552. variable used with the
  9553. <link linkend='ref-classes-image-live'><filename>image-live</filename></link>
  9554. class.
  9555. </para>
  9556. </glossdef>
  9557. </glossentry>
  9558. <glossentry id='var-ROOTFS_POSTINSTALL_COMMAND'><glossterm>ROOTFS_POSTINSTALL_COMMAND</glossterm>
  9559. <info>
  9560. ROOTFS_POSTINSTALL_COMMAND[doc] = "Specifies a list of functions to call after installing packages."
  9561. </info>
  9562. <glossdef>
  9563. <para role="glossdeffirst">
  9564. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9565. Specifies a list of functions to call after the
  9566. OpenEmbedded build system has installed packages.
  9567. You can specify functions separated by semicolons:
  9568. <literallayout class='monospaced'>
  9569. ROOTFS_POSTINSTALL_COMMAND += "<replaceable>function</replaceable>; ... "
  9570. </literallayout>
  9571. </para>
  9572. <para>
  9573. If you need to pass the root filesystem path to a command
  9574. within a function, you can use
  9575. <filename>${IMAGE_ROOTFS}</filename>, which points to
  9576. the directory that becomes the root filesystem image.
  9577. See the
  9578. <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link>
  9579. variable for more information.
  9580. </para>
  9581. </glossdef>
  9582. </glossentry>
  9583. <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm>
  9584. <info>
  9585. ROOTFS_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the root filesystem."
  9586. </info>
  9587. <glossdef>
  9588. <para role="glossdeffirst">
  9589. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9590. Specifies a list of functions to call once the
  9591. OpenEmbedded build system has created the root filesystem.
  9592. You can specify functions separated by semicolons:
  9593. <literallayout class='monospaced'>
  9594. ROOTFS_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... "
  9595. </literallayout>
  9596. </para>
  9597. <para>
  9598. If you need to pass the root filesystem path to a command
  9599. within a function, you can use
  9600. <filename>${IMAGE_ROOTFS}</filename>, which points to
  9601. the directory that becomes the root filesystem image.
  9602. See the
  9603. <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link>
  9604. variable for more information.
  9605. </para>
  9606. </glossdef>
  9607. </glossentry>
  9608. <glossentry id='var-ROOTFS_POSTUNINSTALL_COMMAND'><glossterm>ROOTFS_POSTUNINSTALL_COMMAND</glossterm>
  9609. <info>
  9610. ROOTFS_POSTUNINSTALL_COMMAND[doc] = "Specifies a list of functions to call after removal of unneeded packages."
  9611. </info>
  9612. <glossdef>
  9613. <para role="glossdeffirst">
  9614. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9615. Specifies a list of functions to call after the
  9616. OpenEmbedded build system has removed unnecessary
  9617. packages.
  9618. When runtime package management is disabled in the
  9619. image, several packages are removed including
  9620. <filename>base-passwd</filename>,
  9621. <filename>shadow</filename>, and
  9622. <filename>update-alternatives</filename>.
  9623. You can specify functions separated by semicolons:
  9624. <literallayout class='monospaced'>
  9625. ROOTFS_POSTUNINSTALL_COMMAND += "<replaceable>function</replaceable>; ... "
  9626. </literallayout>
  9627. </para>
  9628. <para>
  9629. If you need to pass the root filesystem path to a command
  9630. within a function, you can use
  9631. <filename>${IMAGE_ROOTFS}</filename>, which points to
  9632. the directory that becomes the root filesystem image.
  9633. See the
  9634. <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link>
  9635. variable for more information.
  9636. </para>
  9637. </glossdef>
  9638. </glossentry>
  9639. <glossentry id='var-ROOTFS_PREPROCESS_COMMAND'><glossterm>ROOTFS_PREPROCESS_COMMAND</glossterm>
  9640. <info>
  9641. ROOTFS_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the root filesystem."
  9642. </info>
  9643. <glossdef>
  9644. <para role="glossdeffirst">
  9645. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9646. Specifies a list of functions to call before the
  9647. OpenEmbedded build system has created the root filesystem.
  9648. You can specify functions separated by semicolons:
  9649. <literallayout class='monospaced'>
  9650. ROOTFS_PREPROCESS_COMMAND += "<replaceable>function</replaceable>; ... "
  9651. </literallayout>
  9652. </para>
  9653. <para>
  9654. If you need to pass the root filesystem path to a command
  9655. within a function, you can use
  9656. <filename>${IMAGE_ROOTFS}</filename>, which points to
  9657. the directory that becomes the root filesystem image.
  9658. See the
  9659. <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link>
  9660. variable for more information.
  9661. </para>
  9662. </glossdef>
  9663. </glossentry>
  9664. <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm>
  9665. <info>
  9666. RPROVIDES[doc] = "A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target."
  9667. </info>
  9668. <glossdef>
  9669. <para role="glossdeffirst">
  9670. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9671. A list of package name aliases that a package also provides.
  9672. These aliases are useful for satisfying runtime dependencies
  9673. of other packages both during the build and on the target
  9674. (as specified by
  9675. <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>).
  9676. <note>
  9677. A package's own name is implicitly already in its
  9678. <filename>RPROVIDES</filename> list.
  9679. </note>
  9680. </para>
  9681. <para>
  9682. As with all package-controlling variables, you must always
  9683. use the variable in conjunction with a package name override.
  9684. Here is an example:
  9685. <literallayout class='monospaced'>
  9686. RPROVIDES_${PN} = "widget-abi-2"
  9687. </literallayout>
  9688. </para>
  9689. </glossdef>
  9690. </glossentry>
  9691. <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm>
  9692. <info>
  9693. RRECOMMENDS[doc] = "A list of packages that extends the usability of a package being built. The package being built does not depend on this list of packages in order to successfully build, but needs them for the extended usability."
  9694. </info>
  9695. <glossdef>
  9696. <para role="glossdeffirst">
  9697. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9698. A list of packages that extends the usability of a package
  9699. being built.
  9700. The package being built does not depend on this list of
  9701. packages in order to successfully build, but rather
  9702. uses them for extended usability.
  9703. To specify runtime dependencies for packages, see the
  9704. <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>
  9705. variable.
  9706. </para>
  9707. <para>
  9708. The package manager will automatically install the
  9709. <filename>RRECOMMENDS</filename> list of packages when
  9710. installing the built package.
  9711. However, you can prevent listed packages from being
  9712. installed by using the
  9713. <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>,
  9714. <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>,
  9715. and
  9716. <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
  9717. variables.
  9718. </para>
  9719. <para>
  9720. Packages specified in
  9721. <filename>RRECOMMENDS</filename> need not actually be
  9722. produced.
  9723. However, a recipe must exist that provides each package,
  9724. either through the
  9725. <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
  9726. or
  9727. <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link>
  9728. variables or the
  9729. <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>
  9730. variable, or an error will occur during the build.
  9731. If such a recipe does exist and the package is not produced,
  9732. the build continues without error.
  9733. </para>
  9734. <para>
  9735. Because the <filename>RRECOMMENDS</filename> variable
  9736. applies to packages being built, you should always attach
  9737. an override to the variable to specify the particular
  9738. package whose usability is being extended.
  9739. For example, suppose you are building a development package
  9740. that is extended to support wireless functionality.
  9741. In this case, you would use the following:
  9742. <literallayout class='monospaced'>
  9743. RRECOMMENDS_${PN}-dev += "<replaceable>wireless_package_name</replaceable>"
  9744. </literallayout>
  9745. In the example, the package name
  9746. (<filename>${<link linkend='var-PN'>PN</link>}-dev</filename>)
  9747. must appear as it would in the
  9748. <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
  9749. namespace before any renaming of the output package by
  9750. classes such as <filename>debian.bbclass</filename>.
  9751. </para>
  9752. <para>
  9753. BitBake, which the OpenEmbedded build system uses, supports
  9754. specifying versioned recommends.
  9755. Although the syntax varies depending on the packaging
  9756. format, BitBake hides these differences from you.
  9757. Here is the general syntax to specify versions with
  9758. the <filename>RRECOMMENDS</filename> variable:
  9759. <literallayout class='monospaced'>
  9760. RRECOMMENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
  9761. </literallayout>
  9762. For <filename>operator</filename>, you can specify the
  9763. following:
  9764. <literallayout class='monospaced'>
  9765. =
  9766. &lt;
  9767. &gt;
  9768. &lt;=
  9769. &gt;=
  9770. </literallayout>
  9771. For example, the following sets up a recommend on version
  9772. 1.2 or greater of the package <filename>foo</filename>:
  9773. <literallayout class='monospaced'>
  9774. RRECOMMENDS_${PN} = "foo (>= 1.2)"
  9775. </literallayout>
  9776. </para>
  9777. </glossdef>
  9778. </glossentry>
  9779. <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
  9780. <info>
  9781. RREPLACES[doc] = "A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) during an upgrade."
  9782. </info>
  9783. <glossdef>
  9784. <para role="glossdeffirst">
  9785. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9786. A list of packages replaced by a package.
  9787. The package manager uses this variable to determine which
  9788. package should be installed to replace other package(s)
  9789. during an upgrade.
  9790. In order to also have the other package(s) removed at the
  9791. same time, you must add the name of the other
  9792. package to the
  9793. <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable.
  9794. </para>
  9795. <para>
  9796. As with all package-controlling variables, you must use
  9797. this variable in conjunction with a package name
  9798. override.
  9799. Here is an example:
  9800. <literallayout class='monospaced'>
  9801. RREPLACES_${PN} = "<replaceable>other_package_being_replaced</replaceable>"
  9802. </literallayout>
  9803. </para>
  9804. <para>
  9805. BitBake, which the OpenEmbedded build system uses, supports
  9806. specifying versioned replacements.
  9807. Although the syntax varies depending on the packaging
  9808. format, BitBake hides these differences from you.
  9809. Here is the general syntax to specify versions with
  9810. the <filename>RREPLACES</filename> variable:
  9811. <literallayout class='monospaced'>
  9812. RREPLACES_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)"
  9813. </literallayout>
  9814. For <filename>operator</filename>, you can specify the
  9815. following:
  9816. <literallayout class='monospaced'>
  9817. =
  9818. &lt;
  9819. &gt;
  9820. &lt;=
  9821. &gt;=
  9822. </literallayout>
  9823. For example, the following sets up a replacement using
  9824. version 1.2 or greater of the package
  9825. <filename>foo</filename>:
  9826. <literallayout class='monospaced'>
  9827. RREPLACES_${PN} = "foo (>= 1.2)"
  9828. </literallayout>
  9829. </para>
  9830. </glossdef>
  9831. </glossentry>
  9832. <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm>
  9833. <info>
  9834. RSUGGESTS[doc] = "A list of additional packages that you can suggest for installation by the package manager at the time a package is installed. Not all package managers support this functionality."
  9835. </info>
  9836. <glossdef>
  9837. <para role="glossdeffirst">
  9838. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9839. A list of additional packages that you can suggest for
  9840. installation by the package manager at the time a package
  9841. is installed.
  9842. Not all package managers support this functionality.
  9843. </para>
  9844. <para>
  9845. As with all package-controlling variables, you must always
  9846. use this variable in conjunction with a package name
  9847. override.
  9848. Here is an example:
  9849. <literallayout class='monospaced'>
  9850. RSUGGESTS_${PN} = "<replaceable>useful_package</replaceable> <replaceable>another_package</replaceable>"
  9851. </literallayout>
  9852. </para>
  9853. </glossdef>
  9854. </glossentry>
  9855. </glossdiv>
  9856. <glossdiv id='var-glossary-s'><title>S</title>
  9857. <glossentry id='var-S'><glossterm>S</glossterm>
  9858. <info>
  9859. S[doc] = "The location in the Build Directory where unpacked package source code resides."
  9860. </info>
  9861. <glossdef>
  9862. <para role="glossdeffirst">
  9863. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9864. The location in the
  9865. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
  9866. where unpacked recipe source code resides.
  9867. By default, this directory is
  9868. <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>,
  9869. where <filename>${BPN}</filename> is the base recipe name
  9870. and <filename>${PV}</filename> is the recipe version.
  9871. If the source tarball extracts the code to a directory
  9872. named anything other than <filename>${BPN}-${PV}</filename>,
  9873. or if the source code if fetched from an SCM such as
  9874. Git or Subversion, then you must set <filename>S</filename>
  9875. in the recipe so that the OpenEmbedded build system
  9876. knows where to find the unpacked source.
  9877. </para>
  9878. <para>
  9879. As an example, assume a
  9880. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  9881. top-level folder named <filename>poky</filename> and a
  9882. default Build Directory at <filename>poky/build</filename>.
  9883. In this case, the work directory the build system uses
  9884. to keep the unpacked recipe for <filename>db</filename>
  9885. is the following:
  9886. <literallayout class='monospaced'>
  9887. poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
  9888. </literallayout>
  9889. The unpacked source code resides in the
  9890. <filename>db-5.1.19</filename> folder.
  9891. </para>
  9892. <para>
  9893. This next example assumes a Git repository.
  9894. By default, Git repositories are cloned to
  9895. <filename>${WORKDIR}/git</filename> during
  9896. <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>.
  9897. Since this path is different from the default value of
  9898. <filename>S</filename>, you must set it specifically
  9899. so the source can be located:
  9900. <literallayout class='monospaced'>
  9901. SRC_URI = "git://path/to/repo.git"
  9902. S = "${WORKDIR}/git"
  9903. </literallayout>
  9904. </para>
  9905. </glossdef>
  9906. </glossentry>
  9907. <glossentry id='var-SANITY_REQUIRED_UTILITIES'><glossterm>SANITY_REQUIRED_UTILITIES</glossterm>
  9908. <info>
  9909. SANITY_REQUIRED_UTILITIES[doc] = "Specifies a list of command-line utilities that should be checked for during the initial sanity checking process when running BitBake."
  9910. </info>
  9911. <glossdef>
  9912. <para role="glossdeffirst">
  9913. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9914. Specifies a list of command-line utilities that should be
  9915. checked for during the initial sanity checking process when
  9916. running BitBake.
  9917. If any of the utilities are not installed on the build host,
  9918. then BitBake immediately exits with an error.
  9919. </para>
  9920. </glossdef>
  9921. </glossentry>
  9922. <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm>
  9923. <info>
  9924. SANITY_TESTED_DISTROS[doc] = "A list of the host distribution identifiers that the build system has been tested against."
  9925. </info>
  9926. <glossdef>
  9927. <para role="glossdeffirst">
  9928. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9929. A list of the host distribution identifiers that the
  9930. build system has been tested against.
  9931. Identifiers consist of the host distributor ID
  9932. followed by the release,
  9933. as reported by the <filename>lsb_release</filename> tool
  9934. or as read from <filename>/etc/lsb-release</filename>.
  9935. Separate the list items with explicit newline
  9936. characters (<filename>\n</filename>).
  9937. If <filename>SANITY_TESTED_DISTROS</filename> is not empty
  9938. and the current value of
  9939. <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link>
  9940. does not appear in the list, then the build system reports
  9941. a warning that indicates the current host distribution has
  9942. not been tested as a build host.
  9943. </para>
  9944. </glossdef>
  9945. </glossentry>
  9946. <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
  9947. <info>
  9948. SDK_ARCH[doc] = "The target architecture for the SDK."
  9949. </info>
  9950. <glossdef>
  9951. <para role="glossdeffirst">
  9952. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9953. The target architecture for the SDK.
  9954. Typically, you do not directly set this variable.
  9955. Instead, use
  9956. <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
  9957. </para>
  9958. </glossdef>
  9959. </glossentry>
  9960. <glossentry id='var-SDK_DEPLOY'><glossterm>SDK_DEPLOY</glossterm>
  9961. <info>
  9962. SDK_DEPLOY[doc] = "The directory set up and used by the populate_sdk_base to which the SDK is deployed."
  9963. </info>
  9964. <glossdef>
  9965. <para role="glossdeffirst">
  9966. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9967. The directory set up and used by the
  9968. <link linkend='ref-classes-populate-sdk'><filename>populate_sdk_base</filename></link>
  9969. to which the SDK is deployed.
  9970. The <filename>populate_sdk_base</filename> class defines
  9971. <filename>SDK_DEPLOY</filename> as follows:
  9972. <literallayout class='monospaced'>
  9973. SDK_DEPLOY = "${<link linkend='var-TMPDIR'>TMPDIR</link>}/deploy/sdk"
  9974. </literallayout>
  9975. </para>
  9976. </glossdef>
  9977. </glossentry>
  9978. <glossentry id='var-SDK_DIR'><glossterm>SDK_DIR</glossterm>
  9979. <info>
  9980. SDK_DIR[doc] = "The parent directory used by the OpenEmbedded build system when creating SDK output."
  9981. </info>
  9982. <glossdef>
  9983. <para role="glossdeffirst">
  9984. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  9985. The parent directory used by the OpenEmbedded build system
  9986. when creating SDK output.
  9987. The
  9988. <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
  9989. class defines the variable as follows:
  9990. <literallayout class='monospaced'>
  9991. SDK_DIR = "${<link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>}/sdk"
  9992. </literallayout>
  9993. <note>
  9994. The <filename>SDK_DIR</filename> directory is a
  9995. temporary directory as it is part of
  9996. <filename>WORKDIR</filename>.
  9997. The final output directory is
  9998. <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>.
  9999. </note>
  10000. </para>
  10001. </glossdef>
  10002. </glossentry>
  10003. <glossentry id='var-SDK_EXT_TYPE'><glossterm>SDK_EXT_TYPE</glossterm>
  10004. <info>
  10005. SDK_EXT_TYPE[doc] = "Controls whether or not shared state artifacts are copied into the extensible SDK."
  10006. </info>
  10007. <glossdef>
  10008. <para role="glossdeffirst">
  10009. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10010. Controls whether or not shared state artifacts are copied
  10011. into the extensible SDK.
  10012. The default value of "full" copies all of the required
  10013. shared state artifacts into the extensible SDK.
  10014. The value "minimal" leaves these artifacts out of the
  10015. SDK.
  10016. <note>
  10017. If you set the variable to "minimal", you need to
  10018. ensure
  10019. <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
  10020. is set in the SDK's configuration to enable the
  10021. artifacts to be fetched as needed.
  10022. </note>
  10023. </para>
  10024. </glossdef>
  10025. </glossentry>
  10026. <glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm>
  10027. <info>
  10028. SDK_HOST_MANIFEST[doc] = "The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK."
  10029. </info>
  10030. <glossdef>
  10031. <para role="glossdeffirst">
  10032. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10033. The manifest file for the host part of the SDK.
  10034. This file lists all the installed packages that make up
  10035. the host part of SDK.
  10036. The file contains package information on a line-per-package
  10037. basis as follows:
  10038. <literallayout class='monospaced'>
  10039. <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable>
  10040. </literallayout>
  10041. </para>
  10042. <para>
  10043. The
  10044. <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
  10045. class defines the manifest file as follows:
  10046. <literallayout class='monospaced'>
  10047. SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest"
  10048. </literallayout>
  10049. The location is derived using the
  10050. <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>
  10051. and
  10052. <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link>
  10053. variables.
  10054. </para>
  10055. </glossdef>
  10056. </glossentry>
  10057. <glossentry id='var-SDK_INCLUDE_PKGDATA'><glossterm>SDK_INCLUDE_PKGDATA</glossterm>
  10058. <info>
  10059. SDK_INCLUDE_PKGDATA[doc] = "When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK."
  10060. </info>
  10061. <glossdef>
  10062. <para role="glossdeffirst">
  10063. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10064. When set to "1", specifies to include the packagedata for
  10065. all recipes in the "world" target in the extensible SDK.
  10066. Including this data allows the
  10067. <filename>devtool search</filename> command to find these
  10068. recipes in search results, as well as allows the
  10069. <filename>devtool add</filename> command to map
  10070. dependencies more effectively.
  10071. <note>
  10072. Enabling the <filename>SDK_INCLUDE_PKGDATA</filename>
  10073. variable significantly increases build time because
  10074. all of world needs to be built.
  10075. Enabling the variable also slightly increases the size
  10076. of the extensible SDK.
  10077. </note>
  10078. </para>
  10079. </glossdef>
  10080. </glossentry>
  10081. <glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm>
  10082. <info>
  10083. SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration."
  10084. </info>
  10085. <glossdef>
  10086. <para role="glossdeffirst">
  10087. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10088. A list of classes to remove from the
  10089. <link linkend='var-INHERIT'><filename>INHERIT</filename></link>
  10090. value globally within the extensible SDK configuration.
  10091. The default value is "buildhistory icecc".
  10092. </para>
  10093. <para>
  10094. Some classes are not generally applicable within
  10095. the extensible SDK context and you can use this variable
  10096. to disable them.
  10097. </para>
  10098. </glossdef>
  10099. </glossentry>
  10100. <glossentry id='var-SDK_LOCAL_CONF_BLACKLIST'><glossterm>SDK_LOCAL_CONF_BLACKLIST</glossterm>
  10101. <info>
  10102. SDK_LOCAL_CONF_BLACKLIST[doc] = "A list of variables not allowed through from the build system configuration into the extensible SDK configuration."
  10103. </info>
  10104. <glossdef>
  10105. <para role="glossdeffirst">
  10106. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10107. A list of variables not allowed through from the build
  10108. system configuration into the extensible SDK configuration.
  10109. Usually, these are variables that are specific to the
  10110. machine on which the build system is running and thus
  10111. would be potentially problematic within the extensible SDK.
  10112. </para>
  10113. </glossdef>
  10114. </glossentry>
  10115. <glossentry id='var-SDK_LOCAL_CONF_WHITELIST'><glossterm>SDK_LOCAL_CONF_WHITELIST</glossterm>
  10116. <info>
  10117. SDK_LOCAL_CONF_WHITELIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration."
  10118. </info>
  10119. <glossdef>
  10120. <para role="glossdeffirst">
  10121. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10122. A list of variables allowed through from the build system
  10123. configuration into the extensible SDK configuration.
  10124. This list overrides the variables specified using the
  10125. <link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link>
  10126. variable as well as any variables identified by automatic
  10127. blacklisting due to the "/" character being found at the
  10128. start of the value, which is usually indicative of being a
  10129. path and thus might not be valid on the system where the
  10130. SDK is installed.
  10131. </para>
  10132. </glossdef>
  10133. </glossentry>
  10134. <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
  10135. <info>
  10136. SDK_NAME[doc] = "The base name for SDK output files."
  10137. </info>
  10138. <glossdef>
  10139. <para role="glossdeffirst">
  10140. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10141. The base name for SDK output files.
  10142. The name is derived from the
  10143. <link linkend='var-DISTRO'><filename>DISTRO</filename></link>,
  10144. <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
  10145. <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>,
  10146. <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
  10147. and
  10148. <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>
  10149. variables:
  10150. <literallayout class='monospaced'>
  10151. SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}"
  10152. </literallayout>
  10153. </para>
  10154. </glossdef>
  10155. </glossentry>
  10156. <glossentry id='var-SDK_OS'><glossterm>SDK_OS</glossterm>
  10157. <info>
  10158. SDK_OS[doc] = "The operating system for which the SDK will be built."
  10159. </info>
  10160. <glossdef>
  10161. <para role="glossdeffirst">
  10162. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10163. Specifies the operating system for which the SDK
  10164. will be built.
  10165. The default value is the value of
  10166. <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>.
  10167. </para>
  10168. </glossdef>
  10169. </glossentry>
  10170. <glossentry id='var-SDK_OUTPUT'><glossterm>SDK_OUTPUT</glossterm>
  10171. <info>
  10172. SDK_OUTPUT[doc] = "The location used by the OpenEmbedded build system when creating SDK output."
  10173. </info>
  10174. <glossdef>
  10175. <para role="glossdeffirst">
  10176. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10177. The location used by the OpenEmbedded build system when
  10178. creating SDK output.
  10179. The
  10180. <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
  10181. class defines the variable as follows:
  10182. <literallayout class='monospaced'>
  10183. SDK_OUTPUT = "${<link linkend='var-SDK_DIR'>SDK_DIR</link>}/image"
  10184. </literallayout>
  10185. <note>
  10186. The <filename>SDK_OUTPUT</filename> directory is a
  10187. temporary directory as it is part of
  10188. <filename>WORKDIR</filename> by way of
  10189. <filename>SDK_DIR</filename>.
  10190. The final output directory is
  10191. <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>.
  10192. </note>
  10193. </para>
  10194. </glossdef>
  10195. </glossentry>
  10196. <glossentry id='var-SDK_PACKAGE_ARCHS'><glossterm>SDK_PACKAGE_ARCHS</glossterm>
  10197. <info>
  10198. SDK_PACKAGE_ARCHS[doc] = "Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not normally be hand-edited."
  10199. </info>
  10200. <glossdef>
  10201. <para role="glossdeffirst">
  10202. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10203. Specifies a list of architectures compatible with
  10204. the SDK machine.
  10205. This variable is set automatically and should not
  10206. normally be hand-edited.
  10207. Entries are separated using spaces and listed in order
  10208. of priority.
  10209. The default value for
  10210. <filename>SDK_PACKAGE_ARCHS</filename> is "all any noarch
  10211. ${SDK_ARCH}-${SDKPKGSUFFIX}".
  10212. </para>
  10213. </glossdef>
  10214. </glossentry>
  10215. <glossentry id='var-SDK_POSTPROCESS_COMMAND'><glossterm>SDK_POSTPROCESS_COMMAND</glossterm>
  10216. <info>
  10217. SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the SDK."
  10218. </info>
  10219. <glossdef>
  10220. <para role="glossdeffirst">
  10221. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10222. Specifies a list of functions to call once the
  10223. OpenEmbedded build system has created the SDK.
  10224. You can specify functions separated by semicolons:
  10225. <literallayout class='monospaced'>
  10226. SDK_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... "
  10227. </literallayout>
  10228. </para>
  10229. <para>
  10230. If you need to pass an SDK path to a command within a
  10231. function, you can use
  10232. <filename>${SDK_DIR}</filename>, which points to
  10233. the parent directory used by the OpenEmbedded build system
  10234. when creating SDK output.
  10235. See the
  10236. <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link>
  10237. variable for more information.
  10238. </para>
  10239. </glossdef>
  10240. </glossentry>
  10241. <glossentry id='var-SDK_PREFIX'><glossterm>SDK_PREFIX</glossterm>
  10242. <info>
  10243. SDK_PREFIX[doc] = "The toolchain binary prefix used for nativesdk recipes."
  10244. </info>
  10245. <glossdef>
  10246. <para role="glossdeffirst">
  10247. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10248. The toolchain binary prefix used for
  10249. <filename>nativesdk</filename> recipes.
  10250. The OpenEmbedded build system uses the
  10251. <filename>SDK_PREFIX</filename> value to set the
  10252. <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>
  10253. when building <filename>nativesdk</filename> recipes.
  10254. The default value is "${SDK_SYS}-".
  10255. </para>
  10256. </glossdef>
  10257. </glossentry>
  10258. <glossentry id='var-SDK_RECRDEP_TASKS'><glossterm>SDK_RECRDEP_TASKS</glossterm>
  10259. <info>
  10260. SDK_RECRDEP_TASKS[doc] = "A list of shared state tasks added to the extensible SDK."
  10261. </info>
  10262. <glossdef>
  10263. <para role="glossdeffirst">
  10264. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10265. A list of shared state tasks added to the extensible SDK.
  10266. By default, the following tasks are added:
  10267. <literallayout class='monospaced'>
  10268. do_populate_lic
  10269. do_package_qa
  10270. do_populate_sysroot
  10271. do_deploy
  10272. </literallayout>
  10273. Despite the default value of "" for the
  10274. <filename>SDK_RECRDEP_TASKS</filename> variable, the
  10275. above four tasks are always added to the SDK.
  10276. To specify tasks beyond these four, you need to use
  10277. the <filename>SDK_RECRDEP_TASKS</filename> variable (e.g.
  10278. you are defining additional tasks that are needed in
  10279. order to build
  10280. <link linkend='var-SDK_TARGETS'><filename>SDK_TARGETS</filename></link>).
  10281. </para>
  10282. </glossdef>
  10283. </glossentry>
  10284. <glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm>
  10285. <info>
  10286. SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built."
  10287. </info>
  10288. <glossdef>
  10289. <para role="glossdeffirst">
  10290. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10291. Specifies the system, including the architecture and the
  10292. operating system, for which the SDK will be built.
  10293. </para>
  10294. <para>
  10295. The OpenEmbedded build system automatically sets this
  10296. variable based on
  10297. <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>,
  10298. <link linkend='var-SDK_VENDOR'><filename>SDK_VENDOR</filename></link>,
  10299. and
  10300. <link linkend='var-SDK_OS'><filename>SDK_OS</filename></link>.
  10301. You do not need to set the <filename>SDK_SYS</filename>
  10302. variable yourself.
  10303. </para>
  10304. </glossdef>
  10305. </glossentry>
  10306. <glossentry id='var-SDK_TARGET_MANIFEST'><glossterm>SDK_TARGET_MANIFEST</glossterm>
  10307. <info>
  10308. SDK_TARGET_MANIFEST[doc] = "The manifest file for the target part of the SDK. This file lists all the installed packages that make up the target part of the SDK."
  10309. </info>
  10310. <glossdef>
  10311. <para role="glossdeffirst">
  10312. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10313. The manifest file for the target part of the SDK.
  10314. This file lists all the installed packages that make up
  10315. the target part of the SDK.
  10316. The file contains package information on a line-per-package
  10317. basis as follows:
  10318. <literallayout class='monospaced'>
  10319. <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable>
  10320. </literallayout>
  10321. </para>
  10322. <para>
  10323. The
  10324. <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
  10325. class defines the manifest file as follows:
  10326. <literallayout class='monospaced'>
  10327. SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest"
  10328. </literallayout>
  10329. The location is derived using the
  10330. <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>
  10331. and
  10332. <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link>
  10333. variables.
  10334. </para>
  10335. </glossdef>
  10336. </glossentry>
  10337. <glossentry id='var-SDK_TARGETS'><glossterm>SDK_TARGETS</glossterm>
  10338. <info>
  10339. SDK_TARGETS[doc] = "A list of targets to install from shared state as part of the standard or extensible SDK installation."
  10340. </info>
  10341. <glossdef>
  10342. <para role="glossdeffirst">
  10343. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10344. A list of targets to install from shared state as part of
  10345. the standard or extensible SDK installation.
  10346. The default value is "${PN}" (i.e. the image from which
  10347. the SDK is built).
  10348. </para>
  10349. <para>
  10350. The <filename>SDK_TARGETS</filename> variable is an
  10351. internal variable and typically would not be changed.
  10352. </para>
  10353. </glossdef>
  10354. </glossentry>
  10355. <glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm>
  10356. <info>
  10357. SDK_TITLE[doc] = "Specifies a title to be printed when running the SDK installer."
  10358. </info>
  10359. <glossdef>
  10360. <para role="glossdeffirst">
  10361. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10362. Specifies a title to be printed when running the SDK
  10363. installer.
  10364. The <filename>SDK_TITLE</filename> variable defaults to
  10365. "<replaceable>distro</replaceable> SDK" for the standard
  10366. SDK and "<replaceable>distro</replaceable> Extensible SDK"
  10367. for the extensible SDK, where
  10368. <replaceable>distro</replaceable> is the first one of
  10369. <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link>
  10370. or
  10371. <link linkend='var-DISTRO'><filename>DISTRO</filename></link>
  10372. that is set in your configuration.
  10373. </para>
  10374. </glossdef>
  10375. </glossentry>
  10376. <glossentry id='var-SDK_UPDATE_URL'><glossterm>SDK_UPDATE_URL</glossterm>
  10377. <info>
  10378. SDK_UPDATE_URL[doc] = "An optional URL for an update server for the extensible SDK."
  10379. </info>
  10380. <glossdef>
  10381. <para role="glossdeffirst">
  10382. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10383. An optional URL for an update server for the extensible
  10384. SDK.
  10385. If set, the value is used as the default update server when
  10386. running <filename>devtool sdk-update</filename> within the
  10387. extensible SDK.
  10388. </para>
  10389. </glossdef>
  10390. </glossentry>
  10391. <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm>
  10392. <info>
  10393. SDK_VENDOR[doc] = "Specifies the name of the SDK vendor."
  10394. </info>
  10395. <glossdef>
  10396. <para role="glossdeffirst">
  10397. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10398. Specifies the name of the SDK vendor.
  10399. </para>
  10400. </glossdef>
  10401. </glossentry>
  10402. <glossentry id='var-SDK_VERSION'><glossterm>SDK_VERSION</glossterm>
  10403. <info>
  10404. SDK_VERSION[doc] = "Specifies the version for the SDK."
  10405. </info>
  10406. <glossdef>
  10407. <para role="glossdeffirst">
  10408. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10409. Specifies the version of the SDK.
  10410. The distribution configuration file (e.g.
  10411. <filename>/meta-poky/conf/distro/poky.conf</filename>)
  10412. defines the <filename>SDK_VERSION</filename> as follows:
  10413. <literallayout class='monospaced'>
  10414. SDK_VERSION := "${@'${DISTRO_VERSION}'.replace('snapshot-${DATE}','snapshot')}"
  10415. </literallayout>
  10416. </para>
  10417. <para>
  10418. For additional information, see the
  10419. <link linkend='var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></link>
  10420. and
  10421. <link linkend='var-DATE'><filename>DATE</filename></link>
  10422. variables.
  10423. </para>
  10424. </glossdef>
  10425. </glossentry>
  10426. <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm>
  10427. <info>
  10428. SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagename'."
  10429. </info>
  10430. <glossdef>
  10431. <para role="glossdeffirst">
  10432. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10433. Equivalent to
  10434. <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>.
  10435. However, this variable applies to the SDK generated from an
  10436. image using the following command:
  10437. <literallayout class='monospaced'>
  10438. $ bitbake -c populate_sdk <replaceable>imagename</replaceable>
  10439. </literallayout>
  10440. </para>
  10441. </glossdef>
  10442. </glossentry>
  10443. <glossentry id='var-SDKMACHINE'><glossterm>SDKMACHINE</glossterm>
  10444. <info>
  10445. SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK items."
  10446. </info>
  10447. <glossdef>
  10448. <para role="glossdeffirst">
  10449. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10450. The machine for which the SDK is built.
  10451. In other words, the SDK is built such that it
  10452. runs on the target you specify with the
  10453. <filename>SDKMACHINE</filename> value.
  10454. The value points to a corresponding
  10455. <filename>.conf</filename> file under
  10456. <filename>conf/machine-sdk/</filename>.
  10457. </para>
  10458. <para>
  10459. You can use "i686" and "x86_64" as possible values
  10460. for this variable. The variable defaults to "i686"
  10461. and is set in the local.conf file in the Build Directory.
  10462. <literallayout class='monospaced'>
  10463. SDKMACHINE ?= "i686"
  10464. </literallayout>
  10465. <note>
  10466. You cannot set the <filename>SDKMACHINE</filename>
  10467. variable in your distribution configuration file.
  10468. If you do, the configuration will not take affect.
  10469. </note>
  10470. </para>
  10471. </glossdef>
  10472. </glossentry>
  10473. <glossentry id='var-SDKPATH'><glossterm>SDKPATH</glossterm>
  10474. <info>
  10475. SDKPATH[doc] = "Defines the path offered to the user for installation of the SDK that is generated by the OpenEmbedded build system."
  10476. </info>
  10477. <glossdef>
  10478. <para role="glossdeffirst">
  10479. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10480. Defines the path offered to the user for installation
  10481. of the SDK that is generated by the OpenEmbedded build
  10482. system.
  10483. The path appears as the default location for installing
  10484. the SDK when you run the SDK's installation script.
  10485. You can override the offered path when you run the
  10486. script.
  10487. </para>
  10488. </glossdef>
  10489. </glossentry>
  10490. <glossentry id='var-SDKTARGETSYSROOT'><glossterm>SDKTARGETSYSROOT</glossterm>
  10491. <info>
  10492. SDKTARGETSYSROOT[doc] = "Full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default SDKPATH."
  10493. </info>
  10494. <glossdef>
  10495. <para role="glossdeffirst">
  10496. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10497. The full path to the sysroot used for cross-compilation
  10498. within an SDK as it will be when installed into the
  10499. default
  10500. <link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>.
  10501. </para>
  10502. </glossdef>
  10503. </glossentry>
  10504. <glossentry id='var-SECTION'><glossterm>SECTION</glossterm>
  10505. <info>
  10506. SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable."
  10507. </info>
  10508. <glossdef>
  10509. <para role="glossdeffirst">
  10510. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10511. The section in which packages should be categorized.
  10512. Package management utilities can make use of this variable.
  10513. </para>
  10514. </glossdef>
  10515. </glossentry>
  10516. <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm>
  10517. <info>
  10518. SELECTED_OPTIMIZATION[doc] = "The variable takes the value of FULL_OPTIMIZATION unless DEBUG_BUILD = '1'. In this case, the value of DEBUG_OPTIMIZATION is used."
  10519. </info>
  10520. <glossdef>
  10521. <para role="glossdeffirst">
  10522. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10523. Specifies the optimization flags passed to the C compiler
  10524. when building for the target.
  10525. The flags are passed through the default value of the
  10526. <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link>
  10527. variable.
  10528. </para>
  10529. <para>
  10530. The <filename>SELECTED_OPTIMIZATION</filename> variable
  10531. takes the value of
  10532. <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename>
  10533. unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1".
  10534. If that is the case, the value of
  10535. <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used.
  10536. </para>
  10537. </glossdef>
  10538. </glossentry>
  10539. <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm>
  10540. <info>
  10541. SERIAL_CONSOLE[doc] = "The speed and device for the serial port used to attach the serial console. This variable is given to the kernel as the 'console' parameter. After booting occurs, getty is started on that port so remote login is possible."
  10542. </info>
  10543. <glossdef>
  10544. <para role="glossdeffirst">
  10545. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10546. Defines a serial console (TTY) to enable using getty.
  10547. Provide a value that specifies the baud rate followed by
  10548. the TTY device name separated by a space.
  10549. You cannot specify more than one TTY device:
  10550. <literallayout class='monospaced'>
  10551. SERIAL_CONSOLE = "115200 ttyS0"
  10552. </literallayout>
  10553. <note>
  10554. The <filename>SERIAL_CONSOLE</filename> variable
  10555. is deprecated.
  10556. Please use the
  10557. <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>
  10558. variable.
  10559. </note>
  10560. </para>
  10561. </glossdef>
  10562. </glossentry>
  10563. <glossentry id='var-SERIAL_CONSOLES'><glossterm>SERIAL_CONSOLES</glossterm>
  10564. <info>
  10565. SERIAL_CONSOLES[doc] = "Defines the serial consoles (TTYs) to enable using getty."
  10566. </info>
  10567. <glossdef>
  10568. <para role="glossdeffirst">
  10569. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10570. Defines the serial consoles (TTYs) to enable using getty.
  10571. Provide a value that specifies the baud rate followed by
  10572. the TTY device name separated by a semicolon.
  10573. Use spaces to separate multiple devices:
  10574. <literallayout class='monospaced'>
  10575. SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1"
  10576. </literallayout>
  10577. </para>
  10578. </glossdef>
  10579. </glossentry>
  10580. <glossentry id='var-SERIAL_CONSOLES_CHECK'><glossterm>SERIAL_CONSOLES_CHECK</glossterm>
  10581. <info>
  10582. SERIAL_CONSOLES_CHECK[doc] = "Similar to SERIAL_CONSOLES except the device is checked for existence before attempting to enable it. Supported only by SysVinit."
  10583. </info>
  10584. <glossdef>
  10585. <para role="glossdeffirst">
  10586. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10587. Similar to
  10588. <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>
  10589. except the device is checked for existence before attempting
  10590. to enable it.
  10591. This variable is currently only supported with SysVinit
  10592. (i.e. not with systemd).
  10593. </para>
  10594. </glossdef>
  10595. </glossentry>
  10596. <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm>
  10597. <info>
  10598. SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from another recipe."
  10599. </info>
  10600. <glossdef>
  10601. <para role="glossdeffirst">
  10602. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10603. A list of recipe dependencies that should not be used to
  10604. determine signatures of tasks from one recipe when they
  10605. depend on tasks from another recipe.
  10606. For example:
  10607. <literallayout class='monospaced'>
  10608. SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
  10609. </literallayout>
  10610. </para>
  10611. <para>
  10612. In this example, <filename>intone</filename> depends on
  10613. <filename>mplayer2</filename>.
  10614. </para>
  10615. <para>
  10616. Use of this variable is one mechanism to remove dependencies
  10617. that affect task signatures and thus force rebuilds when a
  10618. recipe changes.
  10619. <note><title>Caution</title>
  10620. If you add an inappropriate dependency for a recipe
  10621. relationship, the software might break during
  10622. runtime if the interface of the second recipe was
  10623. changed after the first recipe had been built.
  10624. </note>
  10625. </para>
  10626. </glossdef>
  10627. </glossentry>
  10628. <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm>
  10629. <info>
  10630. SIGGEN_EXCLUDERECIPES_ABISAFE[doc] = "A list of recipes that are completely stable and will never change."
  10631. </info>
  10632. <glossdef>
  10633. <para role="glossdeffirst">
  10634. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10635. A list of recipes that are completely stable and will
  10636. never change.
  10637. The ABI for the recipes in the list are presented by
  10638. output from the tasks run to build the recipe.
  10639. Use of this variable is one way to remove dependencies from
  10640. one recipe on another that affect task signatures and
  10641. thus force rebuilds when the recipe changes.
  10642. <note><title>Caution</title>
  10643. If you add an inappropriate variable to this list,
  10644. the software might break at runtime if the
  10645. interface of the recipe was changed after the other
  10646. had been built.
  10647. </note>
  10648. </para>
  10649. </glossdef>
  10650. </glossentry>
  10651. <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm>
  10652. <info>
  10653. SITEINFO_BITS[doc] = "Specifies the number of bits for the target system CPU."
  10654. </info>
  10655. <glossdef>
  10656. <para role="glossdeffirst">
  10657. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10658. Specifies the number of bits for the target system CPU.
  10659. The value should be either "32" or "64".
  10660. </para>
  10661. </glossdef>
  10662. </glossentry>
  10663. <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm>
  10664. <info>
  10665. SITEINFO_ENDIANNESS[doc] = "Specifies the endian byte order of the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'."
  10666. </info>
  10667. <glossdef>
  10668. <para role="glossdeffirst">
  10669. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10670. Specifies the endian byte order of the target system.
  10671. The value should be either "le" for little-endian or "be" for big-endian.
  10672. </para>
  10673. </glossdef>
  10674. </glossentry>
  10675. <glossentry id='var-SKIP_FILEDEPS'><glossterm>SKIP_FILEDEPS</glossterm>
  10676. <info>
  10677. SKIP_FILEDEPS[doc] = "Enables you to remove all files from
  10678. the "Provides" section of an RPM package."
  10679. </info>
  10680. <glossdef>
  10681. <para role="glossdeffirst">
  10682. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10683. Enables removal of all files from the "Provides" section of
  10684. an RPM package.
  10685. Removal of these files is required for packages containing
  10686. prebuilt binaries and libraries such as
  10687. <filename>libstdc++</filename> and
  10688. <filename>glibc</filename>.
  10689. </para>
  10690. <para>
  10691. To enable file removal, set the variable to "1" in your
  10692. <filename>conf/local.conf</filename> configuration file
  10693. in your:
  10694. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  10695. <literallayout class='monospaced'>
  10696. SKIP_FILEDEPS = "1"
  10697. </literallayout>
  10698. </para>
  10699. </glossdef>
  10700. </glossentry>
  10701. <glossentry id='var-SOC_FAMILY'><glossterm>SOC_FAMILY</glossterm>
  10702. <info>
  10703. SOC_FAMILY[doc] = "Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common .inc file that you include in the configuration files of all the machines."
  10704. </info>
  10705. <glossdef>
  10706. <para role="glossdeffirst">
  10707. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10708. Groups together machines based upon the same family
  10709. of SOC (System On Chip).
  10710. You typically set this variable in a common
  10711. <filename>.inc</filename> file that you include in the
  10712. configuration files of all the machines.
  10713. <note>
  10714. You must include
  10715. <filename>conf/machine/include/soc-family.inc</filename>
  10716. for this variable to appear in
  10717. <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>.
  10718. </note>
  10719. </para>
  10720. </glossdef>
  10721. </glossentry>
  10722. <glossentry id='var-SOLIBS'><glossterm>SOLIBS</glossterm>
  10723. <info>
  10724. SOLIBS[doc] = "Defines the suffix for shared libraries used on the target platform."
  10725. </info>
  10726. <glossdef>
  10727. <para role="glossdeffirst">
  10728. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10729. Defines the suffix for shared libraries used on the
  10730. target platform.
  10731. By default, this suffix is ".so.*" for all Linux-based
  10732. systems and is defined in the
  10733. <filename>meta/conf/bitbake.conf</filename> configuration
  10734. file.
  10735. </para>
  10736. <para>
  10737. You will see this variable referenced in the default values
  10738. of <filename>FILES_${PN}</filename>.
  10739. </para>
  10740. </glossdef>
  10741. </glossentry>
  10742. <glossentry id='var-SOLIBSDEV'><glossterm>SOLIBSDEV</glossterm>
  10743. <info>
  10744. SOLIBSDEV[doc] = "Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform."
  10745. </info>
  10746. <glossdef>
  10747. <para role="glossdeffirst">
  10748. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10749. Defines the suffix for the development symbolic link
  10750. (symlink) for shared libraries on the target platform.
  10751. By default, this suffix is ".so" for Linux-based
  10752. systems and is defined in the
  10753. <filename>meta/conf/bitbake.conf</filename> configuration
  10754. file.
  10755. </para>
  10756. <para>
  10757. You will see this variable referenced in the default values
  10758. of <filename>FILES_${PN}-dev</filename>.
  10759. </para>
  10760. </glossdef>
  10761. </glossentry>
  10762. <glossentry id='var-SOURCE_MIRROR_FETCH'><glossterm>SOURCE_MIRROR_FETCH</glossterm>
  10763. <info>
  10764. SOURCE_MIRROR_FETCH[doc] = "Set as part of a source mirror generation script to skip COMPATIBLE_MACHINE and COMPATIBLE_HOST checks."
  10765. </info>
  10766. <glossdef>
  10767. <para role="glossdeffirst">
  10768. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10769. When you are fetching files to create a mirror of sources
  10770. (i.e. creating a source mirror), setting
  10771. <filename>SOURCE_MIRROR_FETCH</filename> to "1" in your
  10772. <filename>local.conf</filename> configuration file ensures
  10773. the source for all recipes are fetched regardless of
  10774. whether or not a recipe is compatible with the
  10775. configuration.
  10776. A recipe is considered incompatible with the currently
  10777. configured machine when either or both the
  10778. <link linkend='var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></link>
  10779. variable and
  10780. <link linkend='var-COMPATIBLE_HOST'><filename>COMPATIBLE_HOST</filename></link>
  10781. variables specify compatibility with a machine other
  10782. than that of the current machine or host.
  10783. <note><title>Warning</title>
  10784. Do not set the
  10785. <filename>SOURCE_MIRROR_FETCH</filename> variable
  10786. unless you are creating a source mirror.
  10787. In other words, do not set the variable during a
  10788. normal build.
  10789. </note>
  10790. </para>
  10791. </glossdef>
  10792. </glossentry>
  10793. <glossentry id='var-SOURCE_MIRROR_URL'><glossterm>SOURCE_MIRROR_URL</glossterm>
  10794. <info>
  10795. SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_URI."
  10796. </info>
  10797. <glossdef>
  10798. <para role="glossdeffirst">
  10799. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10800. Defines your own
  10801. <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
  10802. from which to first fetch source before attempting to fetch
  10803. from the upstream specified in
  10804. <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>.
  10805. </para>
  10806. <para>
  10807. To use this variable, you must globally inherit the
  10808. <link linkend='ref-classes-own-mirrors'><filename>own-mirrors</filename></link>
  10809. class and then provide the URL to your mirrors.
  10810. Here is the general syntax:
  10811. <literallayout class='monospaced'>
  10812. INHERIT += "own-mirrors"
  10813. SOURCE_MIRROR_URL = "http://<replaceable>example</replaceable>.com/<replaceable>my_source_mirror</replaceable>"
  10814. </literallayout>
  10815. <note>
  10816. You can specify only a single URL in
  10817. <filename>SOURCE_MIRROR_URL</filename>.
  10818. </note>
  10819. </para>
  10820. </glossdef>
  10821. </glossentry>
  10822. <glossentry id='var-SPDXLICENSEMAP'><glossterm>SPDXLICENSEMAP</glossterm>
  10823. <info>
  10824. SPDXLICENSEMAP[doc] = "Maps commonly used license names to their SPDX counterparts found in meta/files/common-licenses/."
  10825. </info>
  10826. <glossdef>
  10827. <para role="glossdeffirst">
  10828. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10829. Maps commonly used license names to their SPDX counterparts
  10830. found in <filename>meta/files/common-licenses/</filename>.
  10831. For the default <filename>SPDXLICENSEMAP</filename>
  10832. mappings, see the
  10833. <filename>meta/conf/licenses.conf</filename> file.
  10834. </para>
  10835. <para>
  10836. For additional information, see the
  10837. <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
  10838. variable.
  10839. </para>
  10840. </glossdef>
  10841. </glossentry>
  10842. <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm>
  10843. <info>
  10844. SPECIAL_PKGSUFFIX[doc] = "A list of prefixes for PN used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances such as the generation of the BPN variable."
  10845. </info>
  10846. <glossdef>
  10847. <para role="glossdeffirst">
  10848. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10849. A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the
  10850. OpenEmbedded build system to create variants of recipes or packages.
  10851. The list specifies the prefixes to strip off during certain circumstances
  10852. such as the generation of the <link linkend='var-BPN'><filename>BPN</filename></link> variable.
  10853. </para>
  10854. </glossdef>
  10855. </glossentry>
  10856. <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
  10857. <info>
  10858. SRC_URI[doc] = "The list of source files - local or remote. This variable tells the OpenEmbedded build system what bits to pull in for the build and how to pull them in."
  10859. </info>
  10860. <glossdef>
  10861. <para role="glossdeffirst">
  10862. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  10863. The list of source files - local or remote.
  10864. This variable tells the OpenEmbedded build system which bits
  10865. to pull in for the build and how to pull them in.
  10866. For example, if the recipe or append file only needs to
  10867. fetch a tarball from the Internet, the recipe or
  10868. append file uses a single <filename>SRC_URI</filename>
  10869. entry.
  10870. On the other hand, if the recipe or append file needs to
  10871. fetch a tarball, apply two patches, and include a custom
  10872. file, the recipe or append file would include four
  10873. instances of the variable.
  10874. </para>
  10875. <para>
  10876. The following list explains the available URI protocols.
  10877. URI protocols are highly dependent on particular BitBake
  10878. Fetcher submodules.
  10879. Depending on the fetcher BitBake uses, various URL
  10880. parameters are employed.
  10881. For specifics on the supported Fetchers, see the
  10882. "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>"
  10883. section in the BitBake User Manual.
  10884. <itemizedlist>
  10885. <listitem><para><emphasis><filename>file://</filename> -</emphasis>
  10886. Fetches files, which are usually files shipped with
  10887. the
  10888. <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
  10889. from the local machine.
  10890. The path is relative to the
  10891. <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
  10892. variable.
  10893. Thus, the build system searches, in order, from the
  10894. following directories, which are assumed to be a
  10895. subdirectories of the directory in which the
  10896. recipe file (<filename>.bb</filename>) or
  10897. append file (<filename>.bbappend</filename>)
  10898. resides:
  10899. <itemizedlist>
  10900. <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
  10901. The base recipe name without any special
  10902. suffix or version numbers.
  10903. </para></listitem>
  10904. <listitem><para><emphasis><filename>${BP}</filename> -</emphasis>
  10905. <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>.
  10906. The base recipe name and version but without
  10907. any special package name suffix.
  10908. </para></listitem>
  10909. <listitem><para><emphasis>files -</emphasis>
  10910. Files within a directory, which is named
  10911. <filename>files</filename> and is also
  10912. alongside the recipe or append file.
  10913. </para></listitem>
  10914. </itemizedlist>
  10915. <note>
  10916. If you want the build system to pick up files
  10917. specified through a
  10918. <filename>SRC_URI</filename>
  10919. statement from your append file, you need to be
  10920. sure to extend the
  10921. <filename>FILESPATH</filename>
  10922. variable by also using the
  10923. <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
  10924. variable from within your append file.
  10925. </note>
  10926. </para></listitem>
  10927. <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a
  10928. Bazaar revision control repository.</para></listitem>
  10929. <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a
  10930. Git revision control repository.</para></listitem>
  10931. <listitem><para><emphasis><filename>osc://</filename> -</emphasis> Fetches files from
  10932. an OSC (OpenSUSE Build service) revision control repository.</para></listitem>
  10933. <listitem><para><emphasis><filename>repo://</filename> -</emphasis> Fetches files from
  10934. a repo (Git) repository.</para></listitem>
  10935. <listitem><para><emphasis><filename>ccrc://</filename> -</emphasis>
  10936. Fetches files from a ClearCase repository.
  10937. </para></listitem>
  10938. <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from
  10939. the Internet using <filename>http</filename>.</para></listitem>
  10940. <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files
  10941. from the Internet using <filename>https</filename>.</para></listitem>
  10942. <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files
  10943. from the Internet using <filename>ftp</filename>.</para></listitem>
  10944. <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from
  10945. a CVS revision control repository.</para></listitem>
  10946. <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from
  10947. a Mercurial (<filename>hg</filename>) revision control repository.</para></listitem>
  10948. <listitem><para><emphasis><filename>p4://</filename> -</emphasis> Fetches files from
  10949. a Perforce (<filename>p4</filename>) revision control repository.</para></listitem>
  10950. <listitem><para><emphasis><filename>ssh://</filename> -</emphasis> Fetches files from
  10951. a secure shell.</para></listitem>
  10952. <listitem><para><emphasis><filename>svn://</filename> -</emphasis> Fetches files from
  10953. a Subversion (<filename>svn</filename>) revision control repository.</para></listitem>
  10954. </itemizedlist>
  10955. </para>
  10956. <para>
  10957. Standard and recipe-specific options for <filename>SRC_URI</filename> exist.
  10958. Here are standard options:
  10959. <itemizedlist>
  10960. <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply
  10961. the patch or not.
  10962. The default action is to apply the patch.</para></listitem>
  10963. <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which
  10964. striplevel to use when applying the patch.
  10965. The default level is 1.</para></listitem>
  10966. <listitem><para><emphasis><filename>patchdir</filename> -</emphasis> Specifies
  10967. the directory in which the patch should be applied.
  10968. The default is <filename>${</filename><link linkend='var-S'><filename>S</filename></link><filename>}</filename>.
  10969. </para></listitem>
  10970. </itemizedlist>
  10971. </para>
  10972. <para>
  10973. Here are options specific to recipes building code from a revision control system:
  10974. <itemizedlist>
  10975. <listitem><para><emphasis><filename>mindate</filename> -</emphasis>
  10976. Apply the patch only if
  10977. <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link>
  10978. is equal to or greater than <filename>mindate</filename>.
  10979. </para></listitem>
  10980. <listitem><para><emphasis><filename>maxdate</filename> -</emphasis>
  10981. Apply the patch only if <filename>SRCDATE</filename>
  10982. is not later than <filename>mindate</filename>.
  10983. </para></listitem>
  10984. <listitem><para><emphasis><filename>minrev</filename> -</emphasis>
  10985. Apply the patch only if <filename>SRCREV</filename>
  10986. is equal to or greater than <filename>minrev</filename>.
  10987. </para></listitem>
  10988. <listitem><para><emphasis><filename>maxrev</filename> -</emphasis>
  10989. Apply the patch only if <filename>SRCREV</filename>
  10990. is not later than <filename>maxrev</filename>.
  10991. </para></listitem>
  10992. <listitem><para><emphasis><filename>rev</filename> -</emphasis>
  10993. Apply the patch only if <filename>SRCREV</filename>
  10994. is equal to <filename>rev</filename>.
  10995. </para></listitem>
  10996. <listitem><para><emphasis><filename>notrev</filename> -</emphasis>
  10997. Apply the patch only if <filename>SRCREV</filename>
  10998. is not equal to <filename>rev</filename>.
  10999. </para></listitem>
  11000. </itemizedlist>
  11001. </para>
  11002. <para>
  11003. Here are some additional options worth mentioning:
  11004. <itemizedlist>
  11005. <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls
  11006. whether or not to unpack the file if it is an archive.
  11007. The default action is to unpack the file.</para></listitem>
  11008. <listitem><para><emphasis><filename>destsuffix</filename> -</emphasis> Places the file
  11009. (or extracts its contents) into the specified
  11010. subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
  11011. when the Git fetcher is used.
  11012. </para></listitem>
  11013. <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file
  11014. (or extracts its contents) into the specified
  11015. subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
  11016. when the local (<filename>file://</filename>)
  11017. fetcher is used.
  11018. </para></listitem>
  11019. <listitem><para><emphasis><filename>localdir</filename> -</emphasis> Places the file
  11020. (or extracts its contents) into the specified
  11021. subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
  11022. when the CVS fetcher is used.
  11023. </para></listitem>
  11024. <listitem><para><emphasis><filename>subpath</filename> -</emphasis>
  11025. Limits the checkout to a specific subpath of the
  11026. tree when using the Git fetcher is used.
  11027. </para></listitem>
  11028. <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a
  11029. name to be used for association with <filename>SRC_URI</filename> checksums
  11030. when you have more than one file specified in <filename>SRC_URI</filename>.
  11031. </para></listitem>
  11032. <listitem><para><emphasis><filename>downloadfilename</filename> -</emphasis> Specifies
  11033. the filename used when storing the downloaded file.</para></listitem>
  11034. </itemizedlist>
  11035. </para>
  11036. </glossdef>
  11037. </glossentry>
  11038. <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm>
  11039. <info>
  11040. SRC_URI_OVERRIDES_PACKAGE_ARCH[doc] = "By default, the OpenEmbedded build system automatically detects whether SRC_URI contains files that are machine-specific. If so, the build system automatically changes PACKAGE_ARCH. Setting this variable to '0' disables this behavior."
  11041. </info>
  11042. <glossdef>
  11043. <para role="glossdeffirst">
  11044. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11045. By default, the OpenEmbedded build system automatically detects whether
  11046. <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>
  11047. contains files that are machine-specific.
  11048. If so, the build system automatically changes
  11049. <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
  11050. Setting this variable to "0" disables this behavior.
  11051. </para>
  11052. </glossdef>
  11053. </glossentry>
  11054. <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm>
  11055. <info>
  11056. SRCDATE[doc] = "The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM)."
  11057. </info>
  11058. <glossdef>
  11059. <para role="glossdeffirst">
  11060. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11061. The date of the source code used to build the package.
  11062. This variable applies only if the source was fetched from a Source Code Manager (SCM).
  11063. </para>
  11064. </glossdef>
  11065. </glossentry>
  11066. <glossentry id='var-SRCPV'><glossterm>SRCPV</glossterm>
  11067. <info>
  11068. SRCPV[doc] = "Returns the version string of the current package. This string is used to help define the value of PV."
  11069. </info>
  11070. <glossdef>
  11071. <para role="glossdeffirst">
  11072. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11073. Returns the version string of the current package.
  11074. This string is used to help define the value of
  11075. <link linkend='var-PV'><filename>PV</filename></link>.
  11076. </para>
  11077. <para>
  11078. The <filename>SRCPV</filename> variable is defined in the
  11079. <filename>meta/conf/bitbake.conf</filename> configuration
  11080. file in the
  11081. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  11082. as follows:
  11083. <literallayout class='monospaced'>
  11084. SRCPV = "${@bb.fetch2.get_srcrev(d)}"
  11085. </literallayout>
  11086. </para>
  11087. <para>
  11088. Recipes that need to define <filename>PV</filename> do so
  11089. with the help of the <filename>SRCPV</filename>.
  11090. For example, the <filename>ofono</filename> recipe
  11091. (<filename>ofono_git.bb</filename>) located in
  11092. <filename>meta/recipes-connectivity</filename> in the
  11093. Source Directory defines <filename>PV</filename> as
  11094. follows:
  11095. <literallayout class='monospaced'>
  11096. PV = "0.12-git${SRCPV}"
  11097. </literallayout>
  11098. </para>
  11099. </glossdef>
  11100. </glossentry>
  11101. <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm>
  11102. <info>
  11103. SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only."
  11104. </info>
  11105. <glossdef>
  11106. <para role="glossdeffirst">
  11107. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11108. The revision of the source code used to build the package.
  11109. This variable applies to Subversion, Git, Mercurial and
  11110. Bazaar only.
  11111. Note that if you want to build a fixed revision and you
  11112. want to avoid performing a query on the remote repository
  11113. every time BitBake parses your recipe, you should specify
  11114. a <filename>SRCREV</filename> that is a
  11115. full revision identifier and not just a tag.
  11116. </para>
  11117. <note>
  11118. For information on limitations when inheriting the latest
  11119. revision of software using <filename>SRCREV</filename>,
  11120. see the
  11121. <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link>
  11122. variable description.
  11123. </note>
  11124. </glossdef>
  11125. </glossentry>
  11126. <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm>
  11127. <info>
  11128. SSTATE_DIR[doc] = "The directory for the shared state cache."
  11129. </info>
  11130. <glossdef>
  11131. <para role="glossdeffirst">
  11132. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11133. The directory for the shared state cache.
  11134. </para>
  11135. </glossdef>
  11136. </glossentry>
  11137. <glossentry id='var-SSTATE_MIRROR_ALLOW_NETWORK'><glossterm>SSTATE_MIRROR_ALLOW_NETWORK</glossterm>
  11138. <info>
  11139. SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network has been disabled by setting BB_NO_NETWORK to "1"."
  11140. </info>
  11141. <glossdef>
  11142. <para role="glossdeffirst">
  11143. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11144. If set to "1", allows fetches from
  11145. mirrors that are specified in
  11146. <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
  11147. to work even when fetching from the network has been
  11148. disabled by setting <filename>BB_NO_NETWORK</filename>
  11149. to "1".
  11150. Using the
  11151. <filename>SSTATE_MIRROR_ALLOW_NETWORK</filename>
  11152. variable is useful if you have set
  11153. <filename>SSTATE_MIRRORS</filename> to point to an
  11154. internal server for your shared state cache, but
  11155. you want to disable any other fetching from the network.
  11156. </para>
  11157. </glossdef>
  11158. </glossentry>
  11159. <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm>
  11160. <info>
  11161. SSTATE_MIRRORS[doc] = "Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the data. You can specify a filesystem directory or a remote URL such as HTTP or FTP."
  11162. </info>
  11163. <glossdef>
  11164. <para role="glossdeffirst">
  11165. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11166. Configures the OpenEmbedded build system to search other
  11167. mirror locations for prebuilt cache data objects before
  11168. building out the data.
  11169. This variable works like fetcher
  11170. <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
  11171. and <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
  11172. and points to the cache locations to check for the shared
  11173. objects.
  11174. </para>
  11175. <para>
  11176. You can specify a filesystem directory or a remote URL such
  11177. as HTTP or FTP.
  11178. The locations you specify need to contain the shared state
  11179. cache (sstate-cache) results from previous builds.
  11180. The sstate-cache you point to can also be from builds on
  11181. other machines.
  11182. </para>
  11183. <para>
  11184. If a mirror uses the same structure as
  11185. <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>,
  11186. you need to add
  11187. "PATH" at the end as shown in the examples below.
  11188. The build system substitutes the correct path within the
  11189. directory structure.
  11190. <literallayout class='monospaced'>
  11191. SSTATE_MIRRORS ?= "\
  11192. file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH;downloadfilename=PATH \n \
  11193. file://.* file:///<replaceable>some-local-dir</replaceable>/sstate/PATH"
  11194. </literallayout>
  11195. </para>
  11196. </glossdef>
  11197. </glossentry>
  11198. <glossentry id='var-STAGING_BASE_LIBDIR_NATIVE'><glossterm>STAGING_BASE_LIBDIR_NATIVE</glossterm>
  11199. <info>
  11200. STAGING_BASE_LIBDIR_NATIVE[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the build host."
  11201. </info>
  11202. <glossdef>
  11203. <para role="glossdeffirst">
  11204. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11205. Specifies the path to the <filename>/lib</filename>
  11206. subdirectory of the sysroot directory for the
  11207. build host.
  11208. </para>
  11209. </glossdef>
  11210. </glossentry>
  11211. <glossentry id='var-STAGING_BASELIBDIR'><glossterm>STAGING_BASELIBDIR</glossterm>
  11212. <info>
  11213. STAGING_BASELIBDIR[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)."
  11214. </info>
  11215. <glossdef>
  11216. <para role="glossdeffirst">
  11217. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11218. Specifies the path to the <filename>/lib</filename>
  11219. subdirectory of the sysroot directory for the target
  11220. for which the current recipe is being built
  11221. (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
  11222. </para>
  11223. </glossdef>
  11224. </glossentry>
  11225. <glossentry id='var-STAGING_BINDIR'><glossterm>STAGING_BINDIR</glossterm>
  11226. <info>
  11227. STAGING_BINDIR[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)."
  11228. </info>
  11229. <glossdef>
  11230. <para role="glossdeffirst">
  11231. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11232. Specifies the path to the
  11233. <filename>/usr/bin</filename> subdirectory of the
  11234. sysroot directory for the target for which the current
  11235. recipe is being built
  11236. (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
  11237. </para>
  11238. </glossdef>
  11239. </glossentry>
  11240. <glossentry id='var-STAGING_BINDIR_CROSS'><glossterm>STAGING_BINDIR_CROSS</glossterm>
  11241. <info>
  11242. STAGING_BINDIR_CROSS[doc] = "Specifies the path to the directory containing binary configuration scripts. These scripts provide configuration information for other software that wants to make use of libraries or include files provided by the software associated with the script."
  11243. </info>
  11244. <glossdef>
  11245. <para role="glossdeffirst">
  11246. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11247. Specifies the path to the directory containing binary
  11248. configuration scripts.
  11249. These scripts provide configuration information for
  11250. other software that wants to make use of libraries or
  11251. include files provided by the software associated with
  11252. the script.
  11253. <note>
  11254. This style of build configuration has been largely
  11255. replaced by <filename>pkg-config</filename>.
  11256. Consequently, if <filename>pkg-config</filename>
  11257. is supported by the library to which you are linking,
  11258. it is recommended you use
  11259. <filename>pkg-config</filename> instead of a
  11260. provided configuration script.
  11261. </note>
  11262. </para>
  11263. </glossdef>
  11264. </glossentry>
  11265. <glossentry id='var-STAGING_BINDIR_NATIVE'><glossterm>STAGING_BINDIR_NATIVE</glossterm>
  11266. <info>
  11267. STAGING_BINDIR_NATIVE[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the build host."
  11268. </info>
  11269. <glossdef>
  11270. <para role="glossdeffirst">
  11271. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11272. Specifies the path to the
  11273. <filename>/usr/bin</filename> subdirectory of the
  11274. sysroot directory for the build host.
  11275. </para>
  11276. </glossdef>
  11277. </glossentry>
  11278. <glossentry id='var-STAGING_DATADIR'><glossterm>STAGING_DATADIR</glossterm>
  11279. <info>
  11280. STAGING_DATADIR[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)."
  11281. </info>
  11282. <glossdef>
  11283. <para role="glossdeffirst">
  11284. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11285. Specifies the path to the <filename>/usr/share</filename>
  11286. subdirectory of the sysroot directory for the target
  11287. for which the current recipe is being built
  11288. (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
  11289. </para>
  11290. </glossdef>
  11291. </glossentry>
  11292. <glossentry id='var-STAGING_DATADIR_NATIVE'><glossterm>STAGING_DATADIR_NATIVE</glossterm>
  11293. <info>
  11294. STAGING_DATADIR_NATIVE[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the build host."
  11295. </info>
  11296. <glossdef>
  11297. <para role="glossdeffirst">
  11298. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11299. Specifies the path to the <filename>/usr/share</filename>
  11300. subdirectory of the sysroot directory for the build host.
  11301. </para>
  11302. </glossdef>
  11303. </glossentry>
  11304. <glossentry id='var-STAGING_DIR'><glossterm>STAGING_DIR</glossterm>
  11305. <info>
  11306. STAGING_DIR[doc] = "Specifies the path to the top-level sysroots directory (i.e. ${TMPDIR}/sysroots)."
  11307. </info>
  11308. <glossdef>
  11309. <para role="glossdeffirst">
  11310. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11311. Specifies the path to the top-level sysroots directory
  11312. (i.e.
  11313. <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots</filename>).
  11314. <note>
  11315. Recipes should never write files directly under
  11316. this directory because the OpenEmbedded build system
  11317. manages the directory automatically.
  11318. Instead, files should be installed to
  11319. <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>
  11320. within your recipe's
  11321. <link linkend='ref-tasks-install'><filename>do_install</filename></link>
  11322. task and then the OpenEmbedded build system will
  11323. stage a subset of those files into the sysroot.
  11324. </note>
  11325. </para>
  11326. </glossdef>
  11327. </glossentry>
  11328. <glossentry id='var-STAGING_DIR_HOST'><glossterm>STAGING_DIR_HOST</glossterm>
  11329. <info>
  11330. STAGING_DIR_HOST[doc] = "Specifies the path to the primary sysroot directory for which the target is being built."
  11331. </info>
  11332. <glossdef>
  11333. <para role="glossdeffirst">
  11334. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11335. Specifies the path to the primary sysroot directory for
  11336. which the target is being built.
  11337. Depending on the type of recipe and the build target, the
  11338. recipe's value is as follows:
  11339. <itemizedlist>
  11340. <listitem><para>For recipes building for the target
  11341. machine, the value is "${STAGING_DIR}/${MACHINE}".
  11342. </para></listitem>
  11343. <listitem><para>For native recipes building
  11344. for the build host, the value is empty given the
  11345. assumption that when building for the build host,
  11346. the build host's own directories should be used.
  11347. </para></listitem>
  11348. <listitem><para>For native SDK
  11349. recipes that build for the SDK
  11350. (<filename>nativesdk</filename>), the value is
  11351. "${STAGING_DIR}/${MULTIMACH_HOST_SYS}".
  11352. </para></listitem>
  11353. </itemizedlist>
  11354. </para>
  11355. </glossdef>
  11356. </glossentry>
  11357. <glossentry id='var-STAGING_DIR_NATIVE'><glossterm>STAGING_DIR_NATIVE</glossterm>
  11358. <info>
  11359. STAGING_DIR_NATIVE[doc] = "Specifies the path to the sysroot directory for the build host."
  11360. </info>
  11361. <glossdef>
  11362. <para role="glossdeffirst">
  11363. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11364. Specifies the path to the sysroot directory for the
  11365. build host.
  11366. </para>
  11367. </glossdef>
  11368. </glossentry>
  11369. <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm>
  11370. <info>
  11371. STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot directory for the target for which the current recipe is being built."
  11372. </info>
  11373. <glossdef>
  11374. <para role="glossdeffirst">
  11375. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11376. Specifies the path to the sysroot directory for the
  11377. target for which the current recipe is being built.
  11378. In most cases, this path is the
  11379. <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>.
  11380. </para>
  11381. <para>
  11382. Some recipes build binaries that can run on the target
  11383. system but those binaries in turn generate code for
  11384. another different system (e.g. cross-canadian recipes).
  11385. Using terminology from GNU, the primary system is referred
  11386. to as the "HOST" and the secondary, or different, system is
  11387. referred to as the "TARGET".
  11388. Thus, the binaries run on the "HOST" system and
  11389. and generate binaries for the "TARGET" system.
  11390. <filename>STAGING_DIR_TARGET</filename> points to the
  11391. sysroot used for the "TARGET" system.
  11392. </para>
  11393. </glossdef>
  11394. </glossentry>
  11395. <glossentry id='var-STAGING_ETCDIR_NATIVE'><glossterm>STAGING_ETCDIR_NATIVE</glossterm>
  11396. <info>
  11397. STAGING_ETCDIR_NATIVE[doc] = "Specifies the path to the /etc subdirectory of the sysroot directory for the build host."
  11398. </info>
  11399. <glossdef>
  11400. <para role="glossdeffirst">
  11401. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11402. Specifies the path to the <filename>/etc</filename>
  11403. subdirectory of the sysroot directory for the
  11404. build host.
  11405. </para>
  11406. </glossdef>
  11407. </glossentry>
  11408. <glossentry id='var-STAGING_EXECPREFIXDIR'><glossterm>STAGING_EXECPREFIXDIR</glossterm>
  11409. <info>
  11410. STAGING_EXECPREFIXDIR[doc] = "Specifies the path to the /usr subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)."
  11411. </info>
  11412. <glossdef>
  11413. <para role="glossdeffirst">
  11414. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11415. Specifies the path to the <filename>/usr</filename>
  11416. subdirectory of the sysroot directory for the target
  11417. for which the current recipe is being built
  11418. (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
  11419. </para>
  11420. </glossdef>
  11421. </glossentry>
  11422. <glossentry id='var-STAGING_INCDIR'><glossterm>STAGING_INCDIR</glossterm>
  11423. <info>
  11424. STAGING_INCDIR[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the target for which the current recipe being built (STAGING_DIR_HOST)."
  11425. </info>
  11426. <glossdef>
  11427. <para role="glossdeffirst">
  11428. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11429. Specifies the path to the
  11430. <filename>/usr/include</filename> subdirectory of the
  11431. sysroot directory for the target for which the current
  11432. recipe being built
  11433. (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
  11434. </para>
  11435. </glossdef>
  11436. </glossentry>
  11437. <glossentry id='var-STAGING_INCDIR_NATIVE'><glossterm>STAGING_INCDIR_NATIVE</glossterm>
  11438. <info>
  11439. STAGING_INCDIR_NATIVE[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the build host."
  11440. </info>
  11441. <glossdef>
  11442. <para role="glossdeffirst">
  11443. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11444. Specifies the path to the <filename>/usr/include</filename>
  11445. subdirectory of the sysroot directory for the build host.
  11446. </para>
  11447. </glossdef>
  11448. </glossentry>
  11449. <glossentry id='var-STAGING_KERNEL_BUILDDIR'><glossterm>STAGING_KERNEL_BUILDDIR</glossterm>
  11450. <info>
  11451. STAGING_KERNEL_BUILDDIR[doc] = "Points to the directory containing the kernel build artifacts."
  11452. </info>
  11453. <glossdef>
  11454. <para role="glossdeffirst">
  11455. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11456. Points to the directory containing the kernel build
  11457. artifacts.
  11458. Recipes building software that needs to access kernel
  11459. build artifacts
  11460. (e.g. <filename>systemtap-uprobes</filename>) can look in
  11461. the directory specified with the
  11462. <filename>STAGING_KERNEL_BUILDDIR</filename> variable to
  11463. find these artifacts after the kernel has been built.
  11464. </para>
  11465. </glossdef>
  11466. </glossentry>
  11467. <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm>
  11468. <info>
  11469. STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules."
  11470. </info>
  11471. <glossdef>
  11472. <para role="glossdeffirst">
  11473. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11474. The directory with kernel headers that are required to build out-of-tree
  11475. modules.
  11476. </para>
  11477. </glossdef>
  11478. </glossentry>
  11479. <glossentry id='var-STAGING_LIBDIR'><glossterm>STAGING_LIBDIR</glossterm>
  11480. <info>
  11481. STAGING_LIBDIR[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)."
  11482. </info>
  11483. <glossdef>
  11484. <para role="glossdeffirst">
  11485. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11486. Specifies the path to the <filename>/usr/lib</filename>
  11487. subdirectory of the sysroot directory for the target for
  11488. which the current recipe is being built
  11489. (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
  11490. </para>
  11491. </glossdef>
  11492. </glossentry>
  11493. <glossentry id='var-STAGING_LIBDIR_NATIVE'><glossterm>STAGING_LIBDIR_NATIVE</glossterm>
  11494. <info>
  11495. STAGING_LIBDIR_NATIVE[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the build host."
  11496. </info>
  11497. <glossdef>
  11498. <para role="glossdeffirst">
  11499. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11500. Specifies the path to the <filename>/usr/lib</filename>
  11501. subdirectory of the sysroot directory for the build host.
  11502. </para>
  11503. </glossdef>
  11504. </glossentry>
  11505. <glossentry id='var-STAMP'><glossterm>STAMP</glossterm>
  11506. <info>
  11507. STAMP[doc] = "Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information."
  11508. </info>
  11509. <glossdef>
  11510. <para role="glossdeffirst">
  11511. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11512. Specifies the base path used to create recipe stamp files.
  11513. The path to an actual stamp file is constructed by evaluating this
  11514. string and then appending additional information.
  11515. Currently, the default assignment for <filename>STAMP</filename>
  11516. as set in the <filename>meta/conf/bitbake.conf</filename> file
  11517. is:
  11518. <literallayout class='monospaced'>
  11519. STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}"
  11520. </literallayout>
  11521. </para>
  11522. <para>
  11523. See <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link>,
  11524. <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>,
  11525. <link linkend='var-PN'><filename>PN</filename></link>,
  11526. <link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>,
  11527. <link linkend='var-PV'><filename>PV</filename></link>, and
  11528. <link linkend='var-PR'><filename>PR</filename></link> for related variable
  11529. information.
  11530. </para>
  11531. </glossdef>
  11532. </glossentry>
  11533. <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm>
  11534. <info>
  11535. STAMPS_DIR[doc] = "Specifies the base directory in which the OpenEmbedded build system places stamps."
  11536. </info>
  11537. <glossdef>
  11538. <para role="glossdeffirst">
  11539. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11540. Specifies the base directory in which the OpenEmbedded
  11541. build system places stamps.
  11542. The default directory is
  11543. <filename>${TMPDIR}/stamps</filename>.
  11544. </para>
  11545. </glossdef>
  11546. </glossentry>
  11547. <glossentry id='var-STRIP'><glossterm>STRIP</glossterm>
  11548. <info>
  11549. STRIP[doc] = "Minimal command and arguments to run 'strip' (strip symbols)."
  11550. </info>
  11551. <glossdef>
  11552. <para role="glossdeffirst">
  11553. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11554. The minimal command and arguments to run
  11555. <filename>strip</filename>, which is used to strip
  11556. symbols.
  11557. </para>
  11558. </glossdef>
  11559. </glossentry>
  11560. <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm>
  11561. <info>
  11562. SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe."
  11563. </info>
  11564. <glossdef>
  11565. <para role="glossdeffirst">
  11566. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11567. The short (72 characters or less) summary of the binary package for packaging
  11568. systems such as <filename>opkg</filename>, <filename>rpm</filename> or
  11569. <filename>dpkg</filename>.
  11570. By default, <filename>SUMMARY</filename> is used to define
  11571. the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>
  11572. variable if <filename>DESCRIPTION</filename> is not set
  11573. in the recipe.
  11574. </para>
  11575. </glossdef>
  11576. </glossentry>
  11577. <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm>
  11578. <info>
  11579. SVNDIR[doc] = "The directory where Subversion checkouts will be stored."
  11580. </info>
  11581. <glossdef>
  11582. <para role="glossdeffirst">
  11583. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11584. The directory in which files checked out of a Subversion
  11585. system are stored.
  11586. </para>
  11587. </glossdef>
  11588. </glossentry>
  11589. <glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm>SYSLINUX_DEFAULT_CONSOLE</glossterm>
  11590. <info>
  11591. SYSLINUX_DEFAULT_CONSOLE[doc] = "Specifies the kernel boot default console."
  11592. </info>
  11593. <glossdef>
  11594. <para role="glossdeffirst">
  11595. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11596. Specifies the kernel boot default console.
  11597. If you want to use a console other than the default,
  11598. set this variable in your recipe as follows where "X" is
  11599. the console number you want to use:
  11600. <literallayout class='monospaced'>
  11601. SYSLINUX_DEFAULT_CONSOLE = "console=ttyX"
  11602. </literallayout>
  11603. </para>
  11604. <para>
  11605. The
  11606. <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
  11607. class initially sets this variable to null but then checks
  11608. for a value later.
  11609. </para>
  11610. </glossdef>
  11611. </glossentry>
  11612. <glossentry id='var-SYSLINUX_OPTS'><glossterm>SYSLINUX_OPTS</glossterm>
  11613. <info>
  11614. SYSLINUX_OPTS[doc] = "Lists additional options to add to the syslinux file."
  11615. </info>
  11616. <glossdef>
  11617. <para role="glossdeffirst">
  11618. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11619. Lists additional options to add to the syslinux file.
  11620. You need to set this variable in your recipe.
  11621. If you want to list multiple options, separate the options
  11622. with a semicolon character (<filename>;</filename>).
  11623. </para>
  11624. <para>
  11625. The
  11626. <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
  11627. class uses this variable to create a set of options.
  11628. </para>
  11629. </glossdef>
  11630. </glossentry>
  11631. <glossentry id='var-SYSLINUX_SERIAL'><glossterm>SYSLINUX_SERIAL</glossterm>
  11632. <info>
  11633. SYSLINUX_SERIAL[doc] = "Specifies the alternate serial port or turns it off."
  11634. </info>
  11635. <glossdef>
  11636. <para role="glossdeffirst">
  11637. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11638. Specifies the alternate serial port or turns it off.
  11639. To turn off serial, set this variable to an empty string
  11640. in your recipe.
  11641. The variable's default value is set in the
  11642. <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
  11643. as follows:
  11644. <literallayout class='monospaced'>
  11645. SYSLINUX_SERIAL ?= "0 115200"
  11646. </literallayout>
  11647. </para>
  11648. <para>
  11649. The class checks for and uses the variable as needed.
  11650. </para>
  11651. </glossdef>
  11652. </glossentry>
  11653. <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm>
  11654. <info>
  11655. SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you are using the boot menu."
  11656. </info>
  11657. <glossdef>
  11658. <para role="glossdeffirst">
  11659. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11660. An <filename>.LSS</filename> file used as the background
  11661. for the VGA boot menu when you are using the boot menu.
  11662. You need to set this variable in your recipe.
  11663. </para>
  11664. <para>
  11665. The
  11666. <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
  11667. class checks for this variable and if found, the
  11668. OpenEmbedded build system installs the splash screen.
  11669. </para>
  11670. </glossdef>
  11671. </glossentry>
  11672. <glossentry id='var-SYSLINUX_SERIAL_TTY'><glossterm>SYSLINUX_SERIAL_TTY</glossterm>
  11673. <info>
  11674. SYSLINUX_SERIAL_TTY[doc] = "Specifies the alternate console=tty... kernel boot argument."
  11675. </info>
  11676. <glossdef>
  11677. <para role="glossdeffirst">
  11678. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11679. Specifies the alternate console=tty... kernel boot argument.
  11680. The variable's default value is set in the
  11681. <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
  11682. as follows:
  11683. <literallayout class='monospaced'>
  11684. SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200"
  11685. </literallayout>
  11686. </para>
  11687. <para>
  11688. The class checks for and uses the variable as needed.
  11689. </para>
  11690. </glossdef>
  11691. </glossentry>
  11692. <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm>
  11693. <info>
  11694. SYSROOT_PREPROCESS_FUNCS[doc] = "A list of functions to execute after files are staged into the sysroot. These functions are usually used to apply additional processing on the staged files, or to stage additional files."
  11695. </info>
  11696. <glossdef>
  11697. <para role="glossdeffirst">
  11698. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11699. A list of functions to execute after files are staged into
  11700. the sysroot.
  11701. These functions are usually used to apply additional
  11702. processing on the staged files, or to stage additional
  11703. files.
  11704. </para>
  11705. </glossdef>
  11706. </glossentry>
  11707. <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm>
  11708. <info>
  11709. SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the service you have specified in SYSTEMD_SERVICE should be started automatically or not."
  11710. </info>
  11711. <glossdef>
  11712. <para role="glossdeffirst">
  11713. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11714. When inheriting the
  11715. <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
  11716. class, this variable specifies whether the service you have
  11717. specified in
  11718. <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link>
  11719. should be started automatically or not.
  11720. By default, the service is enabled to automatically start
  11721. at boot time.
  11722. The default setting is in the
  11723. <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
  11724. class as follows:
  11725. <literallayout class='monospaced'>
  11726. SYSTEMD_AUTO_ENABLE ??= "enable"
  11727. </literallayout>
  11728. </para>
  11729. <para>
  11730. You can disable the service by setting the variable to
  11731. "disable".
  11732. </para>
  11733. </glossdef>
  11734. </glossentry>
  11735. <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm>
  11736. <info>
  11737. SYSTEMD_PACKAGES[doc] = "For recipes that inherit the systemd class, this variable locates the systemd unit files when they are not found in the main recipe's package."
  11738. </info>
  11739. <glossdef>
  11740. <para role="glossdeffirst">
  11741. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11742. When inheriting the
  11743. <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
  11744. class, this variable locates the systemd unit files when
  11745. they are not found in the main recipe's package.
  11746. By default, the
  11747. <filename>SYSTEMD_PACKAGES</filename> variable is set
  11748. such that the systemd unit files are assumed to reside in
  11749. the recipes main package:
  11750. <literallayout class='monospaced'>
  11751. SYSTEMD_PACKAGES ?= "${PN}"
  11752. </literallayout>
  11753. </para>
  11754. <para>
  11755. If these unit files are not in this recipe's main
  11756. package, you need to use
  11757. <filename>SYSTEMD_PACKAGES</filename> to list the package
  11758. or packages in which the build system can find the systemd
  11759. unit files.
  11760. </para>
  11761. </glossdef>
  11762. </glossentry>
  11763. <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm>
  11764. <info>
  11765. SYSTEMD_SERVICE[doc] = "For recipes that inherit the systemd class, this variable specifies the systemd service name for a package."
  11766. </info>
  11767. <glossdef>
  11768. <para role="glossdeffirst">
  11769. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11770. When inheriting the
  11771. <link linkend='ref-classes-systemd'><filename>systemd</filename></link>
  11772. class, this variable specifies the systemd service name for
  11773. a package.
  11774. </para>
  11775. <para>
  11776. When you specify this file in your recipe, use a package
  11777. name override to indicate the package to which the value
  11778. applies.
  11779. Here is an example from the connman recipe:
  11780. <literallayout class='monospaced'>
  11781. SYSTEMD_SERVICE_${PN} = "connman.service"
  11782. </literallayout>
  11783. </para>
  11784. </glossdef>
  11785. </glossentry>
  11786. <glossentry id='var-SYSVINIT_ENABLED_GETTYS'><glossterm>SYSVINIT_ENABLED_GETTYS</glossterm>
  11787. <info>
  11788. SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should be running a getty, the default is '1'."
  11789. </info>
  11790. <glossdef>
  11791. <para role="glossdeffirst">
  11792. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11793. When using
  11794. <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>,
  11795. specifies a space-separated list of the virtual terminals
  11796. that should be running a
  11797. <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink>
  11798. (allowing login), assuming
  11799. <link linkend='var-USE_VT'><filename>USE_VT</filename></link>
  11800. is not set to "0".
  11801. </para>
  11802. <para>
  11803. The default value for
  11804. <filename>SYSVINIT_ENABLED_GETTYS</filename> is "1"
  11805. (i.e. only run a getty on the first virtual terminal).
  11806. </para>
  11807. </glossdef>
  11808. </glossentry>
  11809. </glossdiv>
  11810. <glossdiv id='var-glossary-t'><title>T</title>
  11811. <glossentry id='var-T'><glossterm>T</glossterm>
  11812. <info>
  11813. T[doc] = "This variable points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe."
  11814. </info>
  11815. <glossdef>
  11816. <para role="glossdeffirst">
  11817. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11818. This variable points to a directory were BitBake places
  11819. temporary files, which consist mostly of task logs and
  11820. scripts, when building a particular recipe.
  11821. The variable is typically set as follows:
  11822. <literallayout class='monospaced'>
  11823. T = "${WORKDIR}/temp"
  11824. </literallayout>
  11825. </para>
  11826. <para>
  11827. The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
  11828. is the directory into which BitBake unpacks and builds the
  11829. recipe.
  11830. The default <filename>bitbake.conf</filename> file sets this variable.</para>
  11831. <para>The <filename>T</filename> variable is not to be confused with
  11832. the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> variable,
  11833. which points to the root of the directory tree where BitBake
  11834. places the output of an entire build.
  11835. </para>
  11836. </glossdef>
  11837. </glossentry>
  11838. <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm>
  11839. <info>
  11840. TARGET_ARCH[doc] = "The architecture of the device being built. The OpenEmbedded build system supports the following architectures: arm, mips, ppc, x86, x86-64."
  11841. </info>
  11842. <glossdef>
  11843. <para role="glossdeffirst">
  11844. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11845. The target machine's architecture.
  11846. The OpenEmbedded build system supports many
  11847. architectures.
  11848. Here is an example list of architectures supported.
  11849. This list is by no means complete as the architecture
  11850. is configurable:
  11851. <literallayout class='monospaced'>
  11852. arm
  11853. i586
  11854. x86_64
  11855. powerpc
  11856. powerpc64
  11857. mips
  11858. mipsel
  11859. </literallayout>
  11860. </para>
  11861. <para>
  11862. For additional information on machine architectures, see
  11863. the
  11864. <link linkend='var-TUNE_ARCH'><filename>TUNE_ARCH</filename></link>
  11865. variable.
  11866. </para>
  11867. </glossdef>
  11868. </glossentry>
  11869. <glossentry id='var-TARGET_AS_ARCH'><glossterm>TARGET_AS_ARCH</glossterm>
  11870. <info>
  11871. TARGET_AS_ARCH[doc] = "Specifies architecture-specific assembler flags for the target system."
  11872. </info>
  11873. <glossdef>
  11874. <para role="glossdeffirst">
  11875. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11876. Specifies architecture-specific assembler flags for the
  11877. target system.
  11878. <filename>TARGET_AS_ARCH</filename> is initialized from
  11879. <link linkend='var-TUNE_ASARGS'><filename>TUNE_ASARGS</filename></link>
  11880. by default in the BitBake configuration file
  11881. (<filename>meta/conf/bitbake.conf</filename>):
  11882. <literallayout class='monospaced'>
  11883. TARGET_AS_ARCH = "${TUNE_ASARGS}"
  11884. </literallayout>
  11885. </para>
  11886. </glossdef>
  11887. </glossentry>
  11888. <glossentry id='var-TARGET_CC_ARCH'><glossterm>TARGET_CC_ARCH</glossterm>
  11889. <info>
  11890. TARGET_CC_ARCH[doc] = "Specifies architecture-specific C compiler flags for the target system."
  11891. </info>
  11892. <glossdef>
  11893. <para role="glossdeffirst">
  11894. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11895. Specifies architecture-specific C compiler flags for the
  11896. target system.
  11897. <filename>TARGET_CC_ARCH</filename> is initialized from
  11898. <link linkend='var-TUNE_CCARGS'><filename>TUNE_CCARGS</filename></link>
  11899. by default.
  11900. <note>
  11901. It is a common workaround to append
  11902. <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>
  11903. to <filename>TARGET_CC_ARCH</filename>
  11904. in recipes that build software for the target that
  11905. would not otherwise respect the exported
  11906. <filename>LDFLAGS</filename> variable.
  11907. </note>
  11908. </para>
  11909. </glossdef>
  11910. </glossentry>
  11911. <glossentry id='var-TARGET_CC_KERNEL_ARCH'><glossterm>TARGET_CC_KERNEL_ARCH</glossterm>
  11912. <info>
  11913. TARGET_CC_KERNEL_ARCH[doc] = "This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune."
  11914. </info>
  11915. <glossdef>
  11916. <para role="glossdeffirst">
  11917. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11918. This is a specific kernel compiler flag for a CPU or
  11919. Application Binary Interface (ABI) tune.
  11920. The flag is used rarely and only for cases where a
  11921. userspace
  11922. <link linkend='var-TUNE_CCARGS'><filename>TUNE_CCARGS</filename></link>
  11923. is not compatible with the kernel compilation.
  11924. The <filename>TARGET_CC_KERNEL_ARCH</filename> variable
  11925. allows the kernel (and associated modules) to use a
  11926. different configuration.
  11927. See the
  11928. <filename>meta/conf/machine/include/arm/feature-arm-thumb.inc</filename>
  11929. file in the
  11930. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  11931. for an example.
  11932. </para>
  11933. </glossdef>
  11934. </glossentry>
  11935. <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm>
  11936. <info>
  11937. TARGET_CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as CFLAGS."
  11938. </info>
  11939. <glossdef>
  11940. <para role="glossdeffirst">
  11941. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11942. Specifies the flags to pass to the C compiler when building
  11943. for the target.
  11944. When building in the target context,
  11945. <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
  11946. is set to the value of this variable by default.
  11947. </para>
  11948. <para>
  11949. Additionally, the SDK's environment setup script sets
  11950. the
  11951. <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
  11952. variable in the environment to the
  11953. <filename>TARGET_CFLAGS</filename> value so that
  11954. executables built using the SDK also have the flags
  11955. applied.
  11956. </para>
  11957. </glossdef>
  11958. </glossentry>
  11959. <glossentry id='var-TARGET_CPPFLAGS'><glossterm>TARGET_CPPFLAGS</glossterm>
  11960. <info>
  11961. TARGET_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target."
  11962. </info>
  11963. <glossdef>
  11964. <para role="glossdeffirst">
  11965. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11966. Specifies the flags to pass to the C pre-processor
  11967. (i.e. to both the C and the C++ compilers) when building
  11968. for the target.
  11969. When building in the target context,
  11970. <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link>
  11971. is set to the value of this variable by default.
  11972. </para>
  11973. <para>
  11974. Additionally, the SDK's environment setup script sets
  11975. the
  11976. <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link>
  11977. variable in the environment to the
  11978. <filename>TARGET_CPPFLAGS</filename> value so that
  11979. executables built using the SDK also have the flags
  11980. applied.
  11981. </para>
  11982. </glossdef>
  11983. </glossentry>
  11984. <glossentry id='var-TARGET_CXXFLAGS'><glossterm>TARGET_CXXFLAGS</glossterm>
  11985. <info>
  11986. TARGET_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the target."
  11987. </info>
  11988. <glossdef>
  11989. <para role="glossdeffirst">
  11990. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  11991. Specifies the flags to pass to the C++ compiler when
  11992. building for the target.
  11993. When building in the target context,
  11994. <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link>
  11995. is set to the value of this variable by default.
  11996. </para>
  11997. <para>
  11998. Additionally, the SDK's environment setup script sets
  11999. the
  12000. <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link>
  12001. variable in the environment to the
  12002. <filename>TARGET_CXXFLAGS</filename> value so that
  12003. executables built using the SDK also have the flags
  12004. applied.
  12005. </para>
  12006. </glossdef>
  12007. </glossentry>
  12008. <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm>
  12009. <info>
  12010. TARGET_FPU[doc] = "Specifies the method for handling FPU code. For FPU-less targets, which include most ARM CPUs, the variable must be set to 'soft'. If not, the kernel emulation gets used, which results in a performance penalty."
  12011. </info>
  12012. <glossdef>
  12013. <para role="glossdeffirst">
  12014. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12015. Specifies the method for handling FPU code.
  12016. For FPU-less targets, which include most ARM CPUs, the variable must be
  12017. set to "soft".
  12018. If not, the kernel emulation gets used, which results in a performance penalty.
  12019. </para>
  12020. </glossdef>
  12021. </glossentry>
  12022. <glossentry id='var-TARGET_LD_ARCH'><glossterm>TARGET_LD_ARCH</glossterm>
  12023. <info>
  12024. TARGET_LD_ARCH[doc] = "Specifies architecture-specific linker flags for the target system."
  12025. </info>
  12026. <glossdef>
  12027. <para role="glossdeffirst">
  12028. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12029. Specifies architecture-specific linker flags for the
  12030. target system.
  12031. <filename>TARGET_LD_ARCH</filename> is initialized from
  12032. <link linkend='var-TUNE_LDARGS'><filename>TUNE_LDARGS</filename></link>
  12033. by default in the BitBake configuration file
  12034. (<filename>meta/conf/bitbake.conf</filename>):
  12035. <literallayout class='monospaced'>
  12036. TARGET_LD_ARCH = "${TUNE_LDARGS}"
  12037. </literallayout>
  12038. </para>
  12039. </glossdef>
  12040. </glossentry>
  12041. <glossentry id='var-TARGET_LDFLAGS'><glossterm>TARGET_LDFLAGS</glossterm>
  12042. <info>
  12043. TARGET_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the target."
  12044. </info>
  12045. <glossdef>
  12046. <para role="glossdeffirst">
  12047. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12048. Specifies the flags to pass to the linker when building
  12049. for the target.
  12050. When building in the target context,
  12051. <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>
  12052. is set to the value of this variable by default.
  12053. </para>
  12054. <para>
  12055. Additionally, the SDK's environment setup script sets
  12056. the
  12057. <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>
  12058. variable in the environment to the
  12059. <filename>TARGET_LDFLAGS</filename> value so that
  12060. executables built using the SDK also have the flags
  12061. applied.
  12062. </para>
  12063. </glossdef>
  12064. </glossentry>
  12065. <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm>
  12066. <info>
  12067. TARGET_OS[doc] = "Specifies the target's operating system."
  12068. </info>
  12069. <glossdef>
  12070. <para role="glossdeffirst">
  12071. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12072. Specifies the target's operating system.
  12073. The variable can be set to "linux" for <filename>glibc</filename>-based systems and
  12074. to "linux-uclibc" for <filename>uclibc</filename>.
  12075. For ARM/EABI targets, there are also "linux-gnueabi" and
  12076. "linux-uclibc-gnueabi" values possible.
  12077. </para>
  12078. </glossdef>
  12079. </glossentry>
  12080. <glossentry id='var-TARGET_PREFIX'><glossterm>TARGET_PREFIX</glossterm>
  12081. <info>
  12082. TARGET_PREFIX[doc] = "The prefix used for the toolchain binary target tools."
  12083. </info>
  12084. <glossdef>
  12085. <para role="glossdeffirst">
  12086. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12087. Specifies the prefix used for the toolchain binary target
  12088. tools.
  12089. </para>
  12090. <para>
  12091. Depending on the type of recipe and the build target,
  12092. <filename>TARGET_PREFIX</filename> is set as follows:
  12093. <itemizedlist>
  12094. <listitem><para>
  12095. For recipes building for the target machine,
  12096. the value is
  12097. "${<link linkend='var-TARGET_SYS'>TARGET_SYS</link>}-".
  12098. </para></listitem>
  12099. <listitem><para>
  12100. For native recipes, the build system sets the
  12101. variable to the value of
  12102. <filename>BUILD_PREFIX</filename>.
  12103. </para></listitem>
  12104. <listitem><para>
  12105. For native SDK recipes
  12106. (<filename>nativesdk</filename>), the
  12107. build system sets the variable to the value of
  12108. <filename>SDK_PREFIX</filename>.
  12109. </para></listitem>
  12110. </itemizedlist>
  12111. </para>
  12112. </glossdef>
  12113. </glossentry>
  12114. <glossentry id='var-TARGET_SYS'><glossterm>TARGET_SYS</glossterm>
  12115. <info>
  12116. TARGET_SYS[doc] = "The target system is comprised of TARGET_ARCH,TARGET_VENDOR and TARGET_OS."
  12117. </info>
  12118. <glossdef>
  12119. <para role="glossdeffirst">
  12120. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12121. Specifies the system, including the architecture and the
  12122. operating system, for which the build is occurring in
  12123. the context of the current recipe.
  12124. </para>
  12125. <para>
  12126. The OpenEmbedded build system automatically sets this
  12127. variable based on
  12128. <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>,
  12129. <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>,
  12130. and
  12131. <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>
  12132. variables.
  12133. <note>
  12134. You do not need to set the
  12135. <filename>TARGET_SYS</filename> variable yourself.
  12136. </note>
  12137. </para>
  12138. <para>
  12139. Consider these two examples:
  12140. <itemizedlist>
  12141. <listitem><para>
  12142. Given a native recipe on a 32-bit, x86 machine
  12143. running Linux, the value is "i686-linux".
  12144. </para></listitem>
  12145. <listitem><para>
  12146. Given a recipe being built for a little-endian,
  12147. MIPS target running Linux, the value might be
  12148. "mipsel-linux".
  12149. </para></listitem>
  12150. </itemizedlist>
  12151. </para>
  12152. </glossdef>
  12153. </glossentry>
  12154. <glossentry id='var-TARGET_VENDOR'><glossterm>TARGET_VENDOR</glossterm>
  12155. <info>
  12156. TARGET_VENDOR[doc] = "The name of the target vendor."
  12157. </info>
  12158. <glossdef>
  12159. <para role="glossdeffirst">
  12160. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12161. Specifies the name of the target vendor.
  12162. </para>
  12163. </glossdef>
  12164. </glossentry>
  12165. <glossentry id='var-TCLIBCAPPEND'><glossterm>TCLIBCAPPEND</glossterm>
  12166. <info>
  12167. TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build."
  12168. </info>
  12169. <glossdef>
  12170. <para role="glossdeffirst">
  12171. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12172. Specifies a suffix to be appended onto the
  12173. <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
  12174. value.
  12175. The suffix identifies the <filename>libc</filename> variant
  12176. for building.
  12177. When you are building for multiple variants with the same
  12178. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
  12179. this mechanism ensures that output for different
  12180. <filename>libc</filename> variants is kept separate to
  12181. avoid potential conflicts.
  12182. </para>
  12183. <para>
  12184. In the <filename>defaultsetup.conf</filename> file, the
  12185. default value of <filename>TCLIBCAPPEND</filename> is
  12186. "-${TCLIBC}".
  12187. However, distros such as poky, which normally only support
  12188. one <filename>libc</filename> variant, set
  12189. <filename>TCLIBCAPPEND</filename> to "" in their distro
  12190. configuration file resulting in no suffix being applied.
  12191. </para>
  12192. </glossdef>
  12193. </glossentry>
  12194. <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm>
  12195. <info>
  12196. TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc' or 'uclibc'."
  12197. </info>
  12198. <glossdef>
  12199. <para role="glossdeffirst">
  12200. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12201. Specifies the GNU standard C library (<filename>libc</filename>)
  12202. variant to use during the build process.
  12203. This variable replaces <filename>POKYLIBC</filename>, which is no longer
  12204. supported.
  12205. </para>
  12206. <para>
  12207. You can select "glibc" or "uclibc".
  12208. </para>
  12209. </glossdef>
  12210. </glossentry>
  12211. <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm>
  12212. <info>
  12213. TCMODE[doc] = "Enables an external toolchain (where provided by an additional layer) if set to a value other than 'default'."
  12214. </info>
  12215. <glossdef>
  12216. <para role="glossdeffirst">
  12217. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12218. Specifies the toolchain selector.
  12219. <filename>TCMODE</filename> controls the characteristics
  12220. of the generated packages and images by telling the
  12221. OpenEmbedded build system which toolchain profile to use.
  12222. By default, the OpenEmbedded build system builds its own
  12223. internal toolchain.
  12224. The variable's default value is "default", which uses
  12225. that internal toolchain.
  12226. <note>
  12227. If <filename>TCMODE</filename> is set to a value
  12228. other than "default", then it is your responsibility
  12229. to ensure that the toolchain is compatible with the
  12230. default toolchain.
  12231. Using older or newer versions of these components
  12232. might cause build problems.
  12233. See the
  12234. <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>
  12235. for the specific components with which the toolchain
  12236. must be compatible.
  12237. </note>
  12238. </para>
  12239. <para>
  12240. The <filename>TCMODE</filename> variable is similar to
  12241. <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
  12242. which controls the variant of the GNU standard C library
  12243. (<filename>libc</filename>) used during the build process:
  12244. <filename>glibc</filename> or <filename>uclibc</filename>.
  12245. </para>
  12246. <para>
  12247. With additional layers, it is possible to use a pre-compiled
  12248. external toolchain.
  12249. One example is the Sourcery G++ Toolchain.
  12250. The support for this toolchain resides in the separate
  12251. <trademark class='registered'>Mentor Graphics</trademark>
  12252. <filename>meta-sourcery</filename> layer at
  12253. <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>.
  12254. </para>
  12255. <para>
  12256. The layer's <filename>README</filename> file contains
  12257. information on how to use the Sourcery G++ Toolchain as
  12258. an external toolchain.
  12259. In summary, you must be sure to add the layer to your
  12260. <filename>bblayers.conf</filename> file in front of the
  12261. <filename>meta</filename> layer and then set the
  12262. <filename>EXTERNAL_TOOLCHAIN</filename>
  12263. variable in your <filename>local.conf</filename> file
  12264. to the location in which you installed the toolchain.
  12265. </para>
  12266. <para>
  12267. The fundamentals used for this example apply to any
  12268. external toolchain.
  12269. You can use <filename>meta-sourcery</filename> as a
  12270. template for adding support for other external toolchains.
  12271. </para>
  12272. </glossdef>
  12273. </glossentry>
  12274. <glossentry id='var-TEST_EXPORT_DIR'><glossterm>TEST_EXPORT_DIR</glossterm>
  12275. <info>
  12276. TEST_EXPORT_DIR[doc] = "The location the OpenEmbedded build system uses to export tests when the TEST_EXPORT_ONLY variable is set to "1"."
  12277. </info>
  12278. <glossdef>
  12279. <para role="glossdeffirst">
  12280. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12281. The location the OpenEmbedded build system uses to export
  12282. tests when the
  12283. <link linkend='var-TEST_EXPORT_ONLY'><filename>TEST_EXPORT_ONLY</filename></link>
  12284. variable is set to "1".
  12285. </para>
  12286. <para>
  12287. The <filename>TEST_EXPORT_DIR</filename> variable defaults
  12288. to <filename>"${TMPDIR}/testimage/${PN}"</filename>.
  12289. </para>
  12290. </glossdef>
  12291. </glossentry>
  12292. <glossentry id='var-TEST_EXPORT_ONLY'><glossterm>TEST_EXPORT_ONLY</glossterm>
  12293. <info>
  12294. TEST_EXPORT_ONLY[doc] = "Specifies to export the tests only. Set this variable to "1" if you do not want to run the tests but you want them to be exported in a manner that you to run them outside of the build system."
  12295. </info>
  12296. <glossdef>
  12297. <para role="glossdeffirst">
  12298. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12299. Specifies to export the tests only.
  12300. Set this variable to "1" if you do not want to run the
  12301. tests but you want them to be exported in a manner that
  12302. you to run them outside of the build system.
  12303. </para>
  12304. </glossdef>
  12305. </glossentry>
  12306. <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm>
  12307. <info>
  12308. TEST_IMAGE[doc] = "Enables test booting of virtual machine images under the QEMU emulator after any root filesystems are created and runs tests against those images."
  12309. </info>
  12310. <glossdef>
  12311. <para role="glossdeffirst">
  12312. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12313. Automatically runs the series of automated tests for
  12314. images when an image is successfully built.
  12315. </para>
  12316. <para>
  12317. These tests are written in Python making use of the
  12318. <filename>unittest</filename> module, and the majority of
  12319. them run commands on the target system over
  12320. <filename>ssh</filename>.
  12321. You can set this variable to "1" in your
  12322. <filename>local.conf</filename> file in the
  12323. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
  12324. to have the OpenEmbedded build system automatically run
  12325. these tests after an image successfully builds:
  12326. <literallayout class='monospaced'>
  12327. TEST_IMAGE = "1"
  12328. </literallayout>
  12329. For more information on enabling, running, and writing
  12330. these tests, see the
  12331. "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
  12332. section in the Yocto Project Development Manual and the
  12333. "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>"
  12334. section.
  12335. </para>
  12336. </glossdef>
  12337. </glossentry>
  12338. <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm>
  12339. <info>
  12340. TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The <filename>TEST_LOG_DIR</filename> variable defaults to "${WORKDIR}/testimage"."
  12341. </info>
  12342. <glossdef>
  12343. <para role="glossdeffirst">
  12344. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12345. Holds the SSH log and the boot log for QEMU machines.
  12346. The <filename>TEST_LOG_DIR</filename> variable defaults
  12347. to <filename>"${WORKDIR}/testimage"</filename>.
  12348. <note>
  12349. Actual test results reside in the task log
  12350. (<filename>log.do_testimage</filename>), which is in
  12351. the <filename>${WORKDIR}/temp/</filename> directory.
  12352. </note>
  12353. </para>
  12354. </glossdef>
  12355. </glossentry>
  12356. <glossentry id='var-TEST_POWERCONTROL_CMD'><glossterm>TEST_POWERCONTROL_CMD</glossterm>
  12357. <info>
  12358. TEST_POWERCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to control the power of the target machine under test"
  12359. </info>
  12360. <glossdef>
  12361. <para role="glossdeffirst">
  12362. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12363. For automated hardware testing, specifies the command to
  12364. use to control the power of the target machine under test.
  12365. Typically, this command would point to a script that
  12366. performs the appropriate action (e.g. interacting
  12367. with a web-enabled power strip).
  12368. The specified command should expect to receive as the last
  12369. argument "off", "on" or "cycle" specifying to power off,
  12370. on, or cycle (power off and then power on) the device,
  12371. respectively.
  12372. </para>
  12373. </glossdef>
  12374. </glossentry>
  12375. <glossentry id='var-TEST_POWERCONTROL_EXTRA_ARGS'><glossterm>TEST_POWERCONTROL_EXTRA_ARGS</glossterm>
  12376. <info>
  12377. TEST_POWERCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_POWERCONTROL_CMD"
  12378. </info>
  12379. <glossdef>
  12380. <para role="glossdeffirst">
  12381. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12382. For automated hardware testing, specifies additional
  12383. arguments to pass through to the command specified in
  12384. <link linkend='var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></link>.
  12385. Setting <filename>TEST_POWERCONTROL_EXTRA_ARGS</filename>
  12386. is optional.
  12387. You can use it if you wish, for example, to separate the
  12388. machine-specific and non-machine-specific parts of the
  12389. arguments.
  12390. </para>
  12391. </glossdef>
  12392. </glossentry>
  12393. <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm>
  12394. <info>
  12395. TEST_QEMUBOOT_TIMEOUT[doc] = "The time in seconds allowed for an image to boot before automated runtime tests begin to run against an image."
  12396. </info>
  12397. <glossdef>
  12398. <para role="glossdeffirst">
  12399. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12400. The time in seconds allowed for an image to boot before
  12401. automated runtime tests begin to run against an
  12402. image.
  12403. The default timeout period to allow the boot process to
  12404. reach the login prompt is 500 seconds.
  12405. You can specify a different value in the
  12406. <filename>local.conf</filename> file.
  12407. </para>
  12408. <para>
  12409. For more information on testing images, see the
  12410. "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
  12411. section in the Yocto Project Development Manual.
  12412. </para>
  12413. </glossdef>
  12414. </glossentry>
  12415. <glossentry id='var-TEST_SERIALCONTROL_CMD'><glossterm>TEST_SERIALCONTROL_CMD</glossterm>
  12416. <info>
  12417. TEST_SERIALCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to connect to the serial console of the target machine under test."
  12418. </info>
  12419. <glossdef>
  12420. <para role="glossdeffirst">
  12421. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12422. For automated hardware testing, specifies the command
  12423. to use to connect to the serial console of the target
  12424. machine under test.
  12425. This command simply needs to connect to the serial console
  12426. and forward that connection to standard input and output
  12427. as any normal terminal program does.
  12428. </para>
  12429. <para>
  12430. For example, to use the Picocom terminal program on
  12431. serial device <filename>/dev/ttyUSB0</filename> at
  12432. 115200bps, you would set the variable as follows:
  12433. <literallayout class='monospaced'>
  12434. TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200"
  12435. </literallayout>
  12436. </para>
  12437. </glossdef>
  12438. </glossentry>
  12439. <glossentry id='var-TEST_SERIALCONTROL_EXTRA_ARGS'><glossterm>TEST_SERIALCONTROL_EXTRA_ARGS</glossterm>
  12440. <info>
  12441. TEST_SERIALCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_SERIALCONTROL_CMD."
  12442. </info>
  12443. <glossdef>
  12444. <para role="glossdeffirst">
  12445. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12446. For automated hardware testing, specifies additional
  12447. arguments to pass through to the command specified in
  12448. <link linkend='var-TEST_SERIALCONTROL_CMD'><filename>TEST_SERIALCONTROL_CMD</filename></link>.
  12449. Setting <filename>TEST_SERIALCONTROL_EXTRA_ARGS</filename>
  12450. is optional.
  12451. You can use it if you wish, for example, to separate the
  12452. machine-specific and non-machine-specific parts of the
  12453. command.
  12454. </para>
  12455. </glossdef>
  12456. </glossentry>
  12457. <glossentry id='var-TEST_SERVER_IP'><glossterm>TEST_SERVER_IP</glossterm>
  12458. <info>
  12459. TEST_SERVER_IP[doc] = "The IP address of the build machine (host machine). This IP address is usually automatically detected."
  12460. </info>
  12461. <glossdef>
  12462. <para role="glossdeffirst">
  12463. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12464. The IP address of the build machine (host machine).
  12465. This IP address is usually automatically detected.
  12466. However, if detection fails, this variable needs to be set
  12467. to the IP address of the build machine (i.e. where
  12468. the build is taking place).
  12469. <note>
  12470. The <filename>TEST_SERVER_IP</filename> variable
  12471. is only used for a small number of tests such as
  12472. the "smart" test suite, which needs to download
  12473. packages from <filename>DEPLOY_DIR/rpm</filename>.
  12474. </note>
  12475. </para>
  12476. </glossdef>
  12477. </glossentry>
  12478. <glossentry id='var-TEST_TARGET'><glossterm>TEST_TARGET</glossterm>
  12479. <info>
  12480. TEST_TARGET[doc] = "For automated runtime testing, specifies the method of deploying the image and running tests on the target machine."
  12481. </info>
  12482. <glossdef>
  12483. <para role="glossdeffirst">
  12484. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12485. Specifies the target controller to use when running tests
  12486. against a test image.
  12487. The default controller to use is "qemu":
  12488. <literallayout class='monospaced'>
  12489. TEST_TARGET = "qemu"
  12490. </literallayout>
  12491. </para>
  12492. <para>
  12493. A target controller is a class that defines how an
  12494. image gets deployed on a target and how a target is started.
  12495. A layer can extend the controllers by adding a module
  12496. in the layer's <filename>/lib/oeqa/controllers</filename>
  12497. directory and by inheriting the
  12498. <filename>BaseTarget</filename> class, which is an abstract
  12499. class that cannot be used as a value of
  12500. <filename>TEST_TARGET</filename>.
  12501. </para>
  12502. <para>
  12503. You can provide the following arguments with
  12504. <filename>TEST_TARGET</filename>:
  12505. <itemizedlist>
  12506. <listitem><para><emphasis>"qemu" and "QemuTarget":</emphasis>
  12507. Boots a QEMU image and runs the tests.
  12508. See the
  12509. "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>"
  12510. section in the Yocto Project Development Manual for
  12511. more information.
  12512. </para></listitem>
  12513. <listitem><para><emphasis>"simpleremote" and "SimpleRemoteTarget":</emphasis>
  12514. Runs the tests on target hardware that is already
  12515. up and running.
  12516. The hardware can be on the network or it can be
  12517. a device running an image on QEMU.
  12518. You must also set
  12519. <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link>
  12520. when you use "simpleremote" or "SimpleRemoteTarget".
  12521. <note>
  12522. This argument is defined in
  12523. <filename>meta/lib/oeqa/targetcontrol.py</filename>.
  12524. The small caps names are kept for compatibility
  12525. reasons.
  12526. </note>
  12527. </para></listitem>
  12528. <listitem><para><emphasis>"GummibootTarget":</emphasis>
  12529. Automatically deploys and runs tests on an
  12530. EFI-enabled machine that has a master image
  12531. installed.
  12532. <note>
  12533. This argument is defined in
  12534. <filename>meta/lib/oeqa/controllers/masterimage.py</filename>.
  12535. </note>
  12536. </para></listitem>
  12537. </itemizedlist>
  12538. </para>
  12539. <para>
  12540. For information on running tests on hardware, see the
  12541. "<ulink url='&YOCTO_DOCS_DEV_URL;#hardware-image-enabling-tests'>Enabling Runtime Tests on Hardware</ulink>"
  12542. section in the Yocto Project Development Manual.
  12543. </para>
  12544. </glossdef>
  12545. </glossentry>
  12546. <glossentry id='var-TEST_TARGET_IP'><glossterm>TEST_TARGET_IP</glossterm>
  12547. <info>
  12548. TEST_TARGET_IP[doc] = "The IP address of your hardware under test."
  12549. </info>
  12550. <glossdef>
  12551. <para role="glossdeffirst">
  12552. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12553. The IP address of your hardware under test.
  12554. The <filename>TEST_TARGET_IP</filename> variable has no
  12555. effect when
  12556. <link linkend='var-TEST_TARGET'><filename>TEST_TARGET</filename></link>
  12557. is set to "qemu".
  12558. </para>
  12559. <para>
  12560. When you specify the IP address, you can also include a
  12561. port.
  12562. Here is an example:
  12563. <literallayout class='monospaced'>
  12564. TEST_TARGET_IP = "192.168.1.4:2201"
  12565. </literallayout>
  12566. Specifying a port is useful when SSH is started on a
  12567. non-standard port or in cases when your hardware under test
  12568. is behind a firewall or network that is not directly
  12569. accessible from your host and you need to do port address
  12570. translation.
  12571. </para>
  12572. </glossdef>
  12573. </glossentry>
  12574. <glossentry id='var-TEST_SUITES'><glossterm>TEST_SUITES</glossterm>
  12575. <info>
  12576. TEST_SUITES[doc] = "An ordered list of tests (modules) to run against an image when performing automated runtime testing."
  12577. </info>
  12578. <glossdef>
  12579. <para role="glossdeffirst">
  12580. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12581. An ordered list of tests (modules) to run against
  12582. an image when performing automated runtime testing.
  12583. </para>
  12584. <para>
  12585. The OpenEmbedded build system provides a core set of tests
  12586. that can be used against images.
  12587. <note>
  12588. Currently, there is only support for running these tests
  12589. under QEMU.
  12590. </note>
  12591. Tests include <filename>ping</filename>,
  12592. <filename>ssh</filename>, <filename>df</filename> among
  12593. others.
  12594. You can add your own tests to the list of tests by
  12595. appending <filename>TEST_SUITES</filename> as follows:
  12596. <literallayout class='monospaced'>
  12597. TEST_SUITES_append = " <replaceable>mytest</replaceable>"
  12598. </literallayout>
  12599. Alternatively, you can provide the "auto" option to
  12600. have all applicable tests run against the image.
  12601. <literallayout class='monospaced'>
  12602. TEST_SUITES_append = " auto"
  12603. </literallayout>
  12604. Using this option causes the build system to automatically
  12605. run tests that are applicable to the image.
  12606. Tests that are not applicable are skipped.
  12607. </para>
  12608. <para>
  12609. The order in which tests are run is important.
  12610. Tests that depend on another test must appear later in the
  12611. list than the test on which they depend.
  12612. For example, if you append the list of tests with two
  12613. tests (<filename>test_A</filename> and
  12614. <filename>test_B</filename>) where
  12615. <filename>test_B</filename> is dependent on
  12616. <filename>test_A</filename>, then you must order the tests
  12617. as follows:
  12618. <literallayout class='monospaced'>
  12619. TEST_SUITES = " test_A test_B"
  12620. </literallayout>
  12621. </para>
  12622. <para>
  12623. For more information on testing images, see the
  12624. "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
  12625. section in the Yocto Project Development Manual.
  12626. </para>
  12627. </glossdef>
  12628. </glossentry>
  12629. <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm>
  12630. <info>
  12631. THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located."
  12632. </info>
  12633. <glossdef>
  12634. <para role="glossdeffirst">
  12635. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12636. The directory in which the file BitBake is currently
  12637. parsing is located.
  12638. Do not manually set this variable.
  12639. </para>
  12640. </glossdef>
  12641. </glossentry>
  12642. <glossentry id='var-TIME'><glossterm>TIME</glossterm>
  12643. <info>
  12644. TIME[doc] = "The time the build was started using HMS format."
  12645. </info>
  12646. <glossdef>
  12647. <para role="glossdeffirst">
  12648. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12649. The time the build was started.
  12650. Times appear using the hour, minute, and second (HMS)
  12651. format (e.g. "140159" for one minute and fifty-nine
  12652. seconds past 1400 hours).
  12653. </para>
  12654. </glossdef>
  12655. </glossentry>
  12656. <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm>
  12657. <info>
  12658. TMPDIR[doc] = "The temporary directory the OpenEmbedded build system uses when it does its work building images. By default, the TMPDIR variable is named tmp within the Build Directory."
  12659. </info>
  12660. <glossdef>
  12661. <para role="glossdeffirst">
  12662. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12663. This variable is the base directory the OpenEmbedded
  12664. build system uses for all build output and intermediate
  12665. files (other than the shared state cache).
  12666. By default, the <filename>TMPDIR</filename> variable points
  12667. to <filename>tmp</filename> within the
  12668. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  12669. </para>
  12670. <para>
  12671. If you want to establish this directory in a location other
  12672. than the default, you can uncomment and edit the following
  12673. statement in the
  12674. <filename>conf/local.conf</filename> file in the
  12675. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
  12676. <literallayout class='monospaced'>
  12677. #TMPDIR = "${TOPDIR}/tmp"
  12678. </literallayout>
  12679. An example use for this scenario is to set
  12680. <filename>TMPDIR</filename> to a local disk, which does
  12681. not use NFS, while having the Build Directory use NFS.
  12682. </para>
  12683. <para>
  12684. The filesystem used by <filename>TMPDIR</filename> must
  12685. have standard filesystem semantics (i.e. mixed-case files
  12686. are unique, POSIX file locking, and persistent inodes).
  12687. Due to various issues with NFS and bugs in some
  12688. implementations, NFS does not meet this minimum
  12689. requirement.
  12690. Consequently, <filename>TMPDIR</filename> cannot be on
  12691. NFS.
  12692. </para>
  12693. </glossdef>
  12694. </glossentry>
  12695. <glossentry id='var-TOOLCHAIN_HOST_TASK'><glossterm>TOOLCHAIN_HOST_TASK</glossterm>
  12696. <info>
  12697. TOOLCHAIN_HOST_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment."
  12698. </info>
  12699. <glossdef>
  12700. <para role="glossdeffirst">
  12701. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12702. This variable lists packages the OpenEmbedded build system
  12703. uses when building an SDK, which contains a
  12704. cross-development environment.
  12705. The packages specified by this variable are part of the
  12706. toolchain set that runs on the
  12707. <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>,
  12708. and each package should usually have the prefix
  12709. <filename>nativesdk-</filename>.
  12710. For example, consider the following command when
  12711. building an SDK:
  12712. <literallayout class='monospaced'>
  12713. $ bitbake -c populate_sdk <replaceable>imagename</replaceable>
  12714. </literallayout>
  12715. In this case, a default list of packages is set in this
  12716. variable, but you can add additional packages to the list.
  12717. </para>
  12718. <para>
  12719. For background information on cross-development toolchains
  12720. in the Yocto Project development environment, see the
  12721. "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
  12722. section.
  12723. For information on setting up a cross-development
  12724. environment, see the
  12725. <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
  12726. </para>
  12727. </glossdef>
  12728. </glossentry>
  12729. <glossentry id='var-TOOLCHAIN_OUTPUTNAME'><glossterm>TOOLCHAIN_OUTPUTNAME</glossterm>
  12730. <info>
  12731. TOOLCHAIN_OUTPUTNAME[doc] = "Defines the name used for the toolchain output."
  12732. </info>
  12733. <glossdef>
  12734. <para role="glossdeffirst">
  12735. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12736. This variable defines the name used for the toolchain
  12737. output.
  12738. The
  12739. <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
  12740. class sets the
  12741. <filename>TOOLCHAIN_OUTPUTNAME</filename> variable as
  12742. follows:
  12743. <literallayout class='monospaced'>
  12744. TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}"
  12745. </literallayout>
  12746. See the
  12747. <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link>
  12748. and
  12749. <link linkend='var-SDK_VERSION'><filename>SDK_VERSION</filename></link>
  12750. variables for additional information.
  12751. </para>
  12752. </glossdef>
  12753. </glossentry>
  12754. <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm>
  12755. <info>
  12756. TOOLCHAIN_TARGET_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK, which includes libraries and headers."
  12757. </info>
  12758. <glossdef>
  12759. <para role="glossdeffirst">
  12760. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12761. This variable lists packages the OpenEmbedded build system
  12762. uses when it creates the target part of an SDK
  12763. (i.e. the part built for the target hardware), which
  12764. includes libraries and headers.
  12765. </para>
  12766. <para>
  12767. For background information on cross-development toolchains
  12768. in the Yocto Project development environment, see the
  12769. "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
  12770. section.
  12771. For information on setting up a cross-development
  12772. environment, see the
  12773. <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
  12774. </para>
  12775. </glossdef>
  12776. </glossentry>
  12777. <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm>
  12778. <info>
  12779. TOPDIR[doc] = "The Build Directory. BitBake automatically sets this variable. The OpenEmbedded build system uses the Build Directory when building images."
  12780. </info>
  12781. <glossdef>
  12782. <para role="glossdeffirst">
  12783. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12784. The top-level
  12785. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
  12786. BitBake automatically sets this variable when you
  12787. initialize your build environment using either
  12788. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
  12789. or
  12790. <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
  12791. </para>
  12792. </glossdef>
  12793. </glossentry>
  12794. <glossentry id='var-TRANSLATED_TARGET_ARCH'><glossterm>TRANSLATED_TARGET_ARCH</glossterm>
  12795. <info>
  12796. TRANSLATED_TARGET_ARCH[doc] = "A sanitized version of TARGET_ARCH. This variable is used where the architecture is needed in a value where underscores are not allowed."
  12797. </info>
  12798. <glossdef>
  12799. <para role="glossdeffirst">
  12800. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12801. A sanitized version of
  12802. <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>.
  12803. This variable is used where the architecture is needed in
  12804. a value where underscores are not allowed, for example
  12805. within package filenames.
  12806. In this case, dash characters replace any underscore
  12807. characters used in TARGET_ARCH.
  12808. </para>
  12809. <para>
  12810. Do not edit this variable.
  12811. </para>
  12812. </glossdef>
  12813. </glossentry>
  12814. <glossentry id='var-TUNE_ARCH'><glossterm>TUNE_ARCH</glossterm>
  12815. <info>
  12816. TUNE_ARCH[doc] = "The GNU canonical architecture for a specific architecture (i.e. arm, armeb, mips, mips64, and so forth)."
  12817. </info>
  12818. <glossdef>
  12819. <para role="glossdeffirst">
  12820. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12821. The GNU canonical architecture for a specific architecture
  12822. (i.e. <filename>arm</filename>,
  12823. <filename>armeb</filename>,
  12824. <filename>mips</filename>,
  12825. <filename>mips64</filename>, and so forth).
  12826. BitBake uses this value to setup configuration.
  12827. </para>
  12828. <para>
  12829. <filename>TUNE_ARCH</filename> definitions are specific to
  12830. a given architecture.
  12831. The definitions can be a single static definition, or
  12832. can be dynamically adjusted.
  12833. You can see details for a given CPU family by looking at
  12834. the architecture's <filename>README</filename> file.
  12835. For example, the
  12836. <filename>meta/conf/machine/include/mips/README</filename>
  12837. file in the
  12838. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  12839. provides information for <filename>TUNE_ARCH</filename>
  12840. specific to the <filename>mips</filename> architecture.
  12841. </para>
  12842. <para>
  12843. <filename>TUNE_ARCH</filename> is tied closely to
  12844. <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>,
  12845. which defines the target machine's architecture.
  12846. The BitBake configuration file
  12847. (<filename>meta/conf/bitbake.conf</filename>) sets
  12848. <filename>TARGET_ARCH</filename> as follows:
  12849. <literallayout class='monospaced'>
  12850. TARGET_ARCH = "${TUNE_ARCH}"
  12851. </literallayout>
  12852. </para>
  12853. <para>
  12854. The following list, which is by no means complete since
  12855. architectures are configurable, shows supported machine
  12856. architectures:
  12857. <literallayout class='monospaced'>
  12858. arm
  12859. i586
  12860. x86_64
  12861. powerpc
  12862. powerpc64
  12863. mips
  12864. mipsel
  12865. </literallayout>
  12866. </para>
  12867. </glossdef>
  12868. </glossentry>
  12869. <glossentry id='var-TUNE_ASARGS'><glossterm>TUNE_ASARGS</glossterm>
  12870. <info>
  12871. TUNE_ASARGS[doc] = "Specifies architecture-specific assembler flags for the target system."
  12872. </info>
  12873. <glossdef>
  12874. <para role="glossdeffirst">
  12875. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12876. Specifies architecture-specific assembler flags for
  12877. the target system.
  12878. The set of flags is based on the selected tune features.
  12879. <filename>TUNE_ASARGS</filename> is set using
  12880. the tune include files, which are typically under
  12881. <filename>meta/conf/machine/include/</filename> and are
  12882. influenced through
  12883. <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
  12884. For example, the
  12885. <filename>meta/conf/machine/include/x86/arch-x86.inc</filename>
  12886. file defines the flags for the x86 architecture as follows:
  12887. <literallayout class='monospaced'>
  12888. TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}"
  12889. </literallayout>
  12890. <note>
  12891. Board Support Packages (BSPs) select the tune.
  12892. The selected tune, in turn, affects the tune variables
  12893. themselves (i.e. the tune can supply its own
  12894. set of flags).
  12895. </note>
  12896. </para>
  12897. </glossdef>
  12898. </glossentry>
  12899. <glossentry id='var-TUNE_CCARGS'><glossterm>TUNE_CCARGS</glossterm>
  12900. <info>
  12901. TUNE_CCARGS[doc] = "Specifies architecture-specific C compiler flags for the target system."
  12902. </info>
  12903. <glossdef>
  12904. <para role="glossdeffirst">
  12905. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12906. Specifies architecture-specific C compiler flags for
  12907. the target system.
  12908. The set of flags is based on the selected tune features.
  12909. <filename>TUNE_CCARGS</filename> is set using
  12910. the tune include files, which are typically under
  12911. <filename>meta/conf/machine/include/</filename> and are
  12912. influenced through
  12913. <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
  12914. <note>
  12915. Board Support Packages (BSPs) select the tune.
  12916. The selected tune, in turn, affects the tune variables
  12917. themselves (i.e. the tune can supply its own
  12918. set of flags).
  12919. </note>
  12920. </para>
  12921. </glossdef>
  12922. </glossentry>
  12923. <glossentry id='var-TUNE_LDARGS'><glossterm>TUNE_LDARGS</glossterm>
  12924. <info>
  12925. TUNE_LDARGS[doc] = "Specifies architecture-specific linker flags for the target system."
  12926. </info>
  12927. <glossdef>
  12928. <para role="glossdeffirst">
  12929. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12930. Specifies architecture-specific linker flags for
  12931. the target system.
  12932. The set of flags is based on the selected tune features.
  12933. <filename>TUNE_LDARGS</filename> is set using
  12934. the tune include files, which are typically under
  12935. <filename>meta/conf/machine/include/</filename> and are
  12936. influenced through
  12937. <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>.
  12938. For example, the
  12939. <filename>meta/conf/machine/include/x86/arch-x86.inc</filename>
  12940. file defines the flags for the x86 architecture as follows:
  12941. <literallayout class='monospaced'>
  12942. TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}"
  12943. </literallayout>
  12944. <note>
  12945. Board Support Packages (BSPs) select the tune.
  12946. The selected tune, in turn, affects the tune variables
  12947. themselves (i.e. the tune can supply its own
  12948. set of flags).
  12949. </note>
  12950. </para>
  12951. </glossdef>
  12952. </glossentry>
  12953. <glossentry id='var-TUNE_FEATURES'><glossterm>TUNE_FEATURES</glossterm>
  12954. <info>
  12955. TUNE_FEATURES[doc] = "Features used to "tune" a compiler for optimal use given a specific processor."
  12956. </info>
  12957. <glossdef>
  12958. <para role="glossdeffirst">
  12959. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12960. Features used to "tune" a compiler for optimal use
  12961. given a specific processor.
  12962. The features are defined within the tune files and allow
  12963. arguments (i.e. <filename>TUNE_*ARGS</filename>) to be
  12964. dynamically generated based on the features.
  12965. </para>
  12966. <para>
  12967. The OpenEmbedded build system verifies the features
  12968. to be sure they are not conflicting and that they are
  12969. supported.
  12970. </para>
  12971. <para>
  12972. The BitBake configuration file
  12973. (<filename>meta/conf/bitbake.conf</filename>) defines
  12974. <filename>TUNE_FEATURES</filename> as follows:
  12975. <literallayout class='monospaced'>
  12976. TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
  12977. </literallayout>
  12978. See the
  12979. <link linkend='var-DEFAULTTUNE'><filename>DEFAULTTUNE</filename></link>
  12980. variable for more information.
  12981. </para>
  12982. </glossdef>
  12983. </glossentry>
  12984. <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
  12985. <info>
  12986. TUNE_PKGARCH[doc] = "The package architecture understood by the packaging system to define the architecture, ABI, and tuning of output packages."
  12987. </info>
  12988. <glossdef>
  12989. <para role="glossdeffirst">
  12990. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  12991. The package architecture understood by the packaging
  12992. system to define the architecture, ABI, and tuning of
  12993. output packages.
  12994. The specific tune is defined using the "_tune" override
  12995. as follows:
  12996. <literallayout class='monospaced'>
  12997. TUNE_PKGARCH_tune-<replaceable>tune</replaceable> = "<replaceable>tune</replaceable>"
  12998. </literallayout>
  12999. </para>
  13000. <para>
  13001. These tune-specific package architectures are defined in
  13002. the machine include files.
  13003. Here is an example of the "core2-32" tuning as used
  13004. in the
  13005. <filename>meta/conf/machine/include/tune-core2.inc</filename>
  13006. file:
  13007. <literallayout class='monospaced'>
  13008. TUNE_PKGARCH_tune-core2-32 = "core2-32"
  13009. </literallayout>
  13010. </para>
  13011. </glossdef>
  13012. </glossentry>
  13013. <glossentry id='var-TUNEABI'><glossterm>TUNEABI</glossterm>
  13014. <info>
  13015. TUNEABI[doc] = "An underlying ABI used by a particular tuning in a given toolchain layer. This feature allows providers using prebuilt libraries to check compatibility of a tuning against their selection of libraries."
  13016. </info>
  13017. <glossdef>
  13018. <para role="glossdeffirst">
  13019. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13020. An underlying Application Binary Interface (ABI) used by
  13021. a particular tuning in a given toolchain layer.
  13022. Providers that use prebuilt libraries can use the
  13023. <filename>TUNEABI</filename>,
  13024. <link linkend='var-TUNEABI_OVERRIDE'><filename>TUNEABI_OVERRIDE</filename></link>,
  13025. and
  13026. <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link>
  13027. variables to check compatibility of tunings against their
  13028. selection of libraries.
  13029. </para>
  13030. <para>
  13031. If <filename>TUNEABI</filename> is undefined, then every
  13032. tuning is allowed.
  13033. See the
  13034. <link linkend='ref-classes-sanity'><filename>sanity</filename></link>
  13035. class to see how the variable is used.
  13036. </para>
  13037. </glossdef>
  13038. </glossentry>
  13039. <glossentry id='var-TUNEABI_OVERRIDE'><glossterm>TUNEABI_OVERRIDE</glossterm>
  13040. <info>
  13041. TUNEABI_OVERRIDE[doc] = "If set, ignores TUNEABI_WHITELIST."
  13042. </info>
  13043. <glossdef>
  13044. <para role="glossdeffirst">
  13045. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13046. If set, the OpenEmbedded system ignores the
  13047. <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link>
  13048. variable.
  13049. Providers that use prebuilt libraries can use the
  13050. <filename>TUNEABI_OVERRIDE</filename>,
  13051. <filename>TUNEABI_WHITELIST</filename>,
  13052. and
  13053. <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link>
  13054. variables to check compatibility of a tuning against their
  13055. selection of libraries.
  13056. </para>
  13057. <para>
  13058. See the
  13059. <link linkend='ref-classes-sanity'><filename>sanity</filename></link>
  13060. class to see how the variable is used.
  13061. </para>
  13062. </glossdef>
  13063. </glossentry>
  13064. <glossentry id='var-TUNEABI_WHITELIST'><glossterm>TUNEABI_WHITELIST</glossterm>
  13065. <info>
  13066. TUNEABI_WHITELIST[doc] = "A whitelist of permissible TUNEABI values. If the variable is not set, all values are allowed."
  13067. </info>
  13068. <glossdef>
  13069. <para role="glossdeffirst">
  13070. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13071. A whitelist of permissible
  13072. <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link>
  13073. values.
  13074. If <filename>TUNEABI_WHITELIST</filename> is not set,
  13075. all tunes are allowed.
  13076. Providers that use prebuilt libraries can use the
  13077. <filename>TUNEABI_WHITELIST</filename>,
  13078. <link linkend='var-TUNEABI_OVERRIDE'><filename>TUNEABI_OVERRIDE</filename></link>,
  13079. and <filename>TUNEABI</filename> variables to check
  13080. compatibility of a tuning against their selection of
  13081. libraries.
  13082. </para>
  13083. <para>
  13084. See the
  13085. <link linkend='ref-classes-sanity'><filename>sanity</filename></link>
  13086. class to see how the variable is used.
  13087. </para>
  13088. </glossdef>
  13089. </glossentry>
  13090. <glossentry id='var-TUNECONFLICTS'><glossterm>TUNECONFLICTS[<replaceable>feature</replaceable>]</glossterm>
  13091. <info>
  13092. TUNECONFLICTS[doc] = "Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with specified feature."
  13093. </info>
  13094. <glossdef>
  13095. <para role="glossdeffirst">
  13096. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13097. Specifies CPU or Application Binary Interface (ABI)
  13098. tuning features that conflict with <replaceable>feature</replaceable>.
  13099. </para>
  13100. <para>
  13101. Known tuning conflicts are specified in the machine include
  13102. files in the
  13103. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  13104. Here is an example from the
  13105. <filename>meta/conf/machine/include/mips/arch-mips.inc</filename>
  13106. include file that lists the "o32" and "n64" features as
  13107. conflicting with the "n32" feature:
  13108. <literallayout class='monospaced'>
  13109. TUNECONFLICTS[n32] = "o32 n64"
  13110. </literallayout>
  13111. </para>
  13112. </glossdef>
  13113. </glossentry>
  13114. <glossentry id='var-TUNEVALID'><glossterm>TUNEVALID[<replaceable>feature</replaceable>]</glossterm>
  13115. <info>
  13116. TUNEVALID[doc] = "Descriptions, stored as flags, of valid tuning features."
  13117. </info>
  13118. <glossdef>
  13119. <para role="glossdeffirst">
  13120. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13121. Specifies a valid CPU or Application Binary Interface (ABI)
  13122. tuning feature.
  13123. The specified feature is stored as a flag.
  13124. Valid features are specified in the machine include files
  13125. (e.g. <filename>meta/conf/machine/include/arm/arch-arm.inc</filename>).
  13126. Here is an example from that file:
  13127. <literallayout class='monospaced'>
  13128. TUNEVALID[bigendian] = "Enable big-endian mode."
  13129. </literallayout>
  13130. </para>
  13131. <para>
  13132. See the machine include files in the
  13133. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
  13134. for these features.
  13135. </para>
  13136. </glossdef>
  13137. </glossentry>
  13138. </glossdiv>
  13139. <glossdiv id='var-glossary-u'><title>U</title>
  13140. <glossentry id='var-UBOOT_CONFIG'><glossterm>UBOOT_CONFIG</glossterm>
  13141. <info>
  13142. UBOOT_CONFIG[doc] = "Configures the UBOOT_MACHINE and can also define IMAGE_FSTYPES for individual cases."
  13143. </info>
  13144. <glossdef>
  13145. <para role="glossdeffirst">
  13146. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13147. Configures the
  13148. <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link>
  13149. and can also define
  13150. <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
  13151. for individual cases.
  13152. </para>
  13153. <para>
  13154. Following is an example from the
  13155. <filename>meta-fsl-arm</filename> layer.
  13156. <literallayout class='monospaced'>
  13157. UBOOT_CONFIG ??= "sd"
  13158. UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard"
  13159. UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config"
  13160. UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs"
  13161. UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config"
  13162. </literallayout>
  13163. In this example, "sd" is selected as the configuration
  13164. of the possible four for the
  13165. <filename>UBOOT_MACHINE</filename>.
  13166. The "sd" configuration defines "mx6qsabreauto_config"
  13167. as the value for <filename>UBOOT_MACHINE</filename>, while
  13168. the "sdcard" specifies the
  13169. <filename>IMAGE_FSTYPES</filename> to use for the U-boot
  13170. image.
  13171. </para>
  13172. <para>
  13173. For more information on how the
  13174. <filename>UBOOT_CONFIG</filename> is handled, see the
  13175. <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass'><filename>uboot-config</filename></ulink>
  13176. class.
  13177. </para>
  13178. </glossdef>
  13179. </glossentry>
  13180. <glossentry id='var-UBOOT_ENTRYPOINT'><glossterm>UBOOT_ENTRYPOINT</glossterm>
  13181. <info>
  13182. UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image."
  13183. </info>
  13184. <glossdef>
  13185. <para role="glossdeffirst">
  13186. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13187. Specifies the entry point for the U-Boot image.
  13188. During U-Boot image creation, the
  13189. <filename>UBOOT_ENTRYPOINT</filename> variable is passed
  13190. as a command-line parameter to the
  13191. <filename>uboot-mkimage</filename> utility.
  13192. </para>
  13193. </glossdef>
  13194. </glossentry>
  13195. <glossentry id='var-UBOOT_LOADADDRESS'><glossterm>UBOOT_LOADADDRESS</glossterm>
  13196. <info>
  13197. UBOOT_LOADADDRESS[doc] = "Specifies the load address for the U-Boot image."
  13198. </info>
  13199. <glossdef>
  13200. <para role="glossdeffirst">
  13201. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13202. Specifies the load address for the U-Boot image.
  13203. During U-Boot image creation, the
  13204. <filename>UBOOT_LOADADDRESS</filename> variable is passed
  13205. as a command-line parameter to the
  13206. <filename>uboot-mkimage</filename> utility.
  13207. </para>
  13208. </glossdef>
  13209. </glossentry>
  13210. <glossentry id='var-UBOOT_LOCALVERSION'><glossterm>UBOOT_LOCALVERSION</glossterm>
  13211. <info>
  13212. UBOOT_LOCALVERSION[doc] = "Appends a string to the name of the local version of the U-Boot image."
  13213. </info>
  13214. <glossdef>
  13215. <para role="glossdeffirst">
  13216. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13217. Appends a string to the name of the local version of the
  13218. U-Boot image.
  13219. For example, assuming the version of the U-Boot image
  13220. built was "2013.10, the full version string reported by
  13221. U-Boot would be "2013.10-yocto" given the following
  13222. statement:
  13223. <literallayout class='monospaced'>
  13224. UBOOT_LOCALVERSION = "-yocto"
  13225. </literallayout>
  13226. </para>
  13227. </glossdef>
  13228. </glossentry>
  13229. <glossentry id='var-UBOOT_MACHINE'><glossterm>UBOOT_MACHINE</glossterm>
  13230. <info>
  13231. UBOOT_MACHINE[doc] = "Specifies the value passed on the make command line when building a U-Boot image."
  13232. </info>
  13233. <glossdef>
  13234. <para role="glossdeffirst">
  13235. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13236. Specifies the value passed on the
  13237. <filename>make</filename> command line when building
  13238. a U-Boot image.
  13239. The value indicates the target platform configuration.
  13240. You typically set this variable from the machine
  13241. configuration file (i.e.
  13242. <filename>conf/machine/<replaceable>machine_name</replaceable>.conf</filename>).
  13243. </para>
  13244. <para>
  13245. Please see the "Selection of Processor Architecture and
  13246. Board Type" section in the U-Boot README for valid values
  13247. for this variable.
  13248. </para>
  13249. </glossdef>
  13250. </glossentry>
  13251. <glossentry id='var-UBOOT_MAKE_TARGET'><glossterm>UBOOT_MAKE_TARGET</glossterm>
  13252. <info>
  13253. UBOOT_MAKE_TARGET[doc] = "Specifies the target called in the Makefile."
  13254. </info>
  13255. <glossdef>
  13256. <para role="glossdeffirst">
  13257. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13258. Specifies the target called in the
  13259. <filename>Makefile</filename>.
  13260. The default target is "all".
  13261. </para>
  13262. </glossdef>
  13263. </glossentry>
  13264. <glossentry id='var-UBOOT_SUFFIX'><glossterm>UBOOT_SUFFIX</glossterm>
  13265. <info>
  13266. UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension."
  13267. </info>
  13268. <glossdef>
  13269. <para role="glossdeffirst">
  13270. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13271. Points to the generated U-Boot extension.
  13272. For example, <filename>u-boot.sb</filename> has a
  13273. <filename>.sb</filename> extension.
  13274. </para>
  13275. <para>
  13276. The default U-Boot extension is
  13277. <filename>.bin</filename>
  13278. </para>
  13279. </glossdef>
  13280. </glossentry>
  13281. <glossentry id='var-UBOOT_TARGET'><glossterm>UBOOT_TARGET</glossterm>
  13282. <info>
  13283. UBOOT_TARGET[doc] = "Specifies the target used for building U-Boot."
  13284. </info>
  13285. <glossdef>
  13286. <para role="glossdeffirst">
  13287. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13288. Specifies the target used for building U-Boot.
  13289. The target is passed directly as part of the "make" command
  13290. (e.g. SPL and AIS).
  13291. If you do not specifically set this variable, the
  13292. OpenEmbedded build process passes and uses "all" for the
  13293. target during the U-Boot building process.
  13294. </para>
  13295. </glossdef>
  13296. </glossentry>
  13297. <glossentry id='var-UNKNOWN_CONFIGURE_WHITELIST'><glossterm>UNKNOWN_CONFIGURE_WHITELIST</glossterm>
  13298. <info>
  13299. UNKNOWN_CONFIGURE_WHITELIST[doc] = "Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the do_configure task."
  13300. </info>
  13301. <glossdef>
  13302. <para role="glossdeffirst">
  13303. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13304. Specifies a list of options that, if reported by the
  13305. configure script as being invalid, should not generate a
  13306. warning during the
  13307. <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
  13308. task.
  13309. Normally, invalid configure options are simply not passed
  13310. to the configure script (e.g. should be removed from
  13311. <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>).
  13312. However, common options, for example, exist that are passed
  13313. to all configure scripts at a class level that might not
  13314. be valid for some configure scripts.
  13315. It follows that no benefit exists in seeing a warning about
  13316. these options.
  13317. For these cases, the options are added to
  13318. <filename>UNKNOWN_CONFIGURE_WHITELIST</filename>.
  13319. </para>
  13320. <para>
  13321. The configure arguments check that uses
  13322. <filename>UNKNOWN_CONFIGURE_WHITELIST</filename> is part
  13323. of the
  13324. <link linkend='ref-classes-insane'><filename>insane</filename></link>
  13325. class and is only enabled if the recipe inherits the
  13326. <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
  13327. class.
  13328. </para>
  13329. </glossdef>
  13330. </glossentry>
  13331. <glossentry id='var-UPDATERCPN'><glossterm>UPDATERCPN</glossterm>
  13332. <info>
  13333. UPDATERCPN[doc] = "Specifies the package that contains the initscript that is to be enabled."
  13334. </info>
  13335. <glossdef>
  13336. <para role="glossdeffirst">
  13337. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13338. For recipes inheriting the
  13339. <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link>
  13340. class, <filename>UPDATERCPN</filename> specifies
  13341. the package that contains the initscript that is to be
  13342. enabled.
  13343. </para>
  13344. <para>
  13345. The default value is "${PN}".
  13346. Given that almost all recipes that install initscripts
  13347. package them in the main package for the recipe, you
  13348. rarely need to set this variable in individual recipes.
  13349. </para>
  13350. </glossdef>
  13351. </glossentry>
  13352. <glossentry id='var-UPSTREAM_CHECK_GITTAGREGEX'><glossterm>UPSTREAM_CHECK_GITTAGREGEX</glossterm>
  13353. <info>
  13354. UPSTREAM_CHECK_GITTAGREGEX[doc] = "Filters relevant Git tags when fetching source from an upstream Git repository."
  13355. </info>
  13356. <glossdef>
  13357. <para role="glossdeffirst">
  13358. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13359. When the
  13360. <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
  13361. class is enabled globally, you can perform a per-recipe
  13362. check for what the latest upstream source code version is
  13363. by calling
  13364. <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>.
  13365. If the recipe source code is provided from Git
  13366. repositories, the OpenEmbedded build system determines the
  13367. latest upstream version by picking the latest tag from the
  13368. list of all repository tags.
  13369. You can use the
  13370. <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
  13371. variable to provide a regular expression to filter only the
  13372. relevant tags should the default filter not work
  13373. correctly.
  13374. <literallayout class='monospaced'>
  13375. UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
  13376. </literallayout>
  13377. </para>
  13378. </glossdef>
  13379. </glossentry>
  13380. <glossentry id='var-UPSTREAM_CHECK_REGEX'><glossterm>UPSTREAM_CHECK_REGEX</glossterm>
  13381. <info>
  13382. UPSTREAM_CHECK_REGEX[doc] = "The regular expression the package checking system uses to parse the page pointed to by UPSTREAM_CHECK_URI."
  13383. </info>
  13384. <glossdef>
  13385. <para role="glossdeffirst">
  13386. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13387. When the
  13388. <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
  13389. class is enabled globally, use the
  13390. <filename>UPSTREAM_CHECK_REGEX</filename> variable to
  13391. specify a different regular expression instead of the
  13392. default one when the package checking system is parsing
  13393. the page found using
  13394. <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>.
  13395. <literallayout class='monospaced'>
  13396. UPSTREAM_CHECK_REGEX = "package_regex"
  13397. </literallayout>
  13398. </para>
  13399. </glossdef>
  13400. </glossentry>
  13401. <glossentry id='var-UPSTREAM_CHECK_URI'><glossterm>UPSTREAM_CHECK_URI</glossterm>
  13402. <info>
  13403. UPSTREAM_CHECK_URI[doc] = "The URL used by the package checking system to get the latest version of the package when source files are fetched from an upstream Git repository."
  13404. </info>
  13405. <glossdef>
  13406. <para role="glossdeffirst">
  13407. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13408. When the
  13409. <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
  13410. class is enabled globally, you can perform a per-recipe
  13411. check for what the latest upstream source code version is
  13412. by calling <filename>bitbake -c checkpkg</filename>
  13413. <replaceable>recipe</replaceable>.
  13414. If the source code is provided from tarballs, the latest
  13415. version is determined by fetching the directory listing
  13416. where the tarball is and attempting to find a later tarball.
  13417. When this approach does not work, you can use
  13418. <filename>UPSTREAM_CHECK_URI</filename> to
  13419. provide a different URI that contains the link to the
  13420. latest tarball.
  13421. <literallayout class='monospaced'>
  13422. UPSTREAM_CHECK_URI = "recipe_url"
  13423. </literallayout>
  13424. </para>
  13425. </glossdef>
  13426. </glossentry>
  13427. <glossentry id='var-USE_DEVFS'><glossterm>USE_DEVFS</glossterm>
  13428. <info>
  13429. USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population."
  13430. </info>
  13431. <glossdef>
  13432. <para role="glossdeffirst">
  13433. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13434. Determines if <filename>devtmpfs</filename> is used for
  13435. <filename>/dev</filename> population.
  13436. The default value used for <filename>USE_DEVFS</filename>
  13437. is "1" when no value is specifically set.
  13438. Typically, you would set <filename>USE_DEVFS</filename>
  13439. to "0" for a statically populated <filename>/dev</filename>
  13440. directory.
  13441. </para>
  13442. <para>
  13443. See the
  13444. "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-dev-manager'>Selecting a Device Manager</ulink>"
  13445. section in the Yocto Project Development Manual for
  13446. information on how to use this variable.
  13447. </para>
  13448. </glossdef>
  13449. </glossentry>
  13450. <glossentry id='var-USE_VT'><glossterm>USE_VT</glossterm>
  13451. <info>
  13452. USE_VT[doc] = "When using SysVinit, determines whether or not to run a getty on any virtual terminals in order to enable logging in through those terminals."
  13453. </info>
  13454. <glossdef>
  13455. <para role="glossdeffirst">
  13456. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13457. When using
  13458. <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>,
  13459. determines whether or not to run a
  13460. <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink>
  13461. on any virtual terminals in order to enable logging in
  13462. through those terminals.
  13463. </para>
  13464. <para>
  13465. The default value used for <filename>USE_VT</filename>
  13466. is "1" when no default value is specifically set.
  13467. Typically, you would set <filename>USE_VT</filename>
  13468. to "0" in the machine configuration file for machines
  13469. that do not have a graphical display attached and
  13470. therefore do not need virtual terminal functionality.
  13471. </para>
  13472. </glossdef>
  13473. </glossentry>
  13474. <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm>
  13475. <info>
  13476. USER_CLASSES[doc] = "List of additional classes to use when building images that enable extra features."
  13477. </info>
  13478. <glossdef>
  13479. <para role="glossdeffirst">
  13480. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13481. A list of classes to globally inherit.
  13482. These classes are used by the OpenEmbedded build system
  13483. to enable extra features (e.g.
  13484. <filename>buildstats</filename>,
  13485. <filename>image-mklibs</filename>, and so forth).
  13486. </para>
  13487. <para>
  13488. The default list is set in your
  13489. <filename>local.conf</filename> file:
  13490. <literallayout class='monospaced'>
  13491. USER_CLASSES ?= "buildstats image-mklibs image-prelink"
  13492. </literallayout>
  13493. For more information, see
  13494. <filename>meta-poky/conf/local.conf.sample</filename> in
  13495. the
  13496. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
  13497. </para>
  13498. </glossdef>
  13499. </glossentry>
  13500. <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm>
  13501. <info>
  13502. USERADD_ERROR_DYNAMIC[doc] = "Forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in files/passwd and files/group files."
  13503. </info>
  13504. <glossdef>
  13505. <para role="glossdeffirst">
  13506. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13507. Forces the OpenEmbedded build system to produce an error
  13508. if the user identification (<filename>uid</filename>) and
  13509. group identification (<filename>gid</filename>) values
  13510. are not defined in <filename>files/passwd</filename>
  13511. and <filename>files/group</filename> files.
  13512. </para>
  13513. <para>
  13514. The default behavior for the build system is to dynamically
  13515. apply <filename>uid</filename> and
  13516. <filename>gid</filename> values.
  13517. Consequently, the <filename>USERADD_ERROR_DYNAMIC</filename>
  13518. variable is by default not set.
  13519. If you plan on using statically assigned
  13520. <filename>gid</filename> and <filename>uid</filename>
  13521. values, you should set
  13522. the <filename>USERADD_ERROR_DYNAMIC</filename> variable in
  13523. your <filename>local.conf</filename> file as
  13524. follows:
  13525. <literallayout class='monospaced'>
  13526. USERADD_ERROR_DYNAMIC = "1"
  13527. </literallayout>
  13528. Overriding the default behavior implies you are going to
  13529. also take steps to set static <filename>uid</filename> and
  13530. <filename>gid</filename> values through use of the
  13531. <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>,
  13532. <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>,
  13533. and
  13534. <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>
  13535. variables.
  13536. </para>
  13537. </glossdef>
  13538. </glossentry>
  13539. <glossentry id='var-USERADD_GID_TABLES'><glossterm>USERADD_GID_TABLES</glossterm>
  13540. <info>
  13541. USERADD_GID_TABLES[doc] = "Specifies a password file to use for obtaining static group identification (gid) values when the OpenEmbedded build system adds a group to the system during package installation."
  13542. </info>
  13543. <glossdef>
  13544. <para role="glossdeffirst">
  13545. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13546. Specifies a password file to use for obtaining static
  13547. group identification (<filename>gid</filename>) values
  13548. when the OpenEmbedded build system adds a group to the
  13549. system during package installation.
  13550. </para>
  13551. <para>
  13552. When applying static group identification
  13553. (<filename>gid</filename>) values, the OpenEmbedded build
  13554. system looks in
  13555. <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
  13556. for a <filename>files/group</filename> file and then applies
  13557. those <filename>uid</filename> values.
  13558. Set the variable as follows in your
  13559. <filename>local.conf</filename> file:
  13560. <literallayout class='monospaced'>
  13561. USERADD_GID_TABLES = "files/group"
  13562. </literallayout>
  13563. </para>
  13564. <note>
  13565. Setting the
  13566. <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>
  13567. variable to "useradd-staticids" causes the build system
  13568. to use static <filename>gid</filename> values.
  13569. </note>
  13570. </glossdef>
  13571. </glossentry>
  13572. <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm>
  13573. <info>
  13574. USERADD_PACKAGES[doc] = "When a recipe inherits the useradd class, this variable specifies the individual packages within the recipe that require users and/or groups to be added."
  13575. </info>
  13576. <glossdef>
  13577. <para role="glossdeffirst">
  13578. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13579. When inheriting the
  13580. <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
  13581. class, this variable
  13582. specifies the individual packages within the recipe that
  13583. require users and/or groups to be added.
  13584. </para>
  13585. <para>
  13586. You must set this variable if the recipe inherits the
  13587. class.
  13588. For example, the following enables adding a user for the
  13589. main package in a recipe:
  13590. <literallayout class='monospaced'>
  13591. USERADD_PACKAGES = "${PN}"
  13592. </literallayout>
  13593. <note>
  13594. If follows that if you are going to use the
  13595. <filename>USERADD_PACKAGES</filename> variable,
  13596. you need to set one or more of the
  13597. <link linkend='var-USERADD_PARAM'><filename>USERADD_PARAM</filename></link>,
  13598. <link linkend='var-GROUPADD_PARAM'><filename>GROUPADD_PARAM</filename></link>,
  13599. or
  13600. <link linkend='var-GROUPMEMS_PARAM'><filename>GROUPMEMS_PARAM</filename></link>
  13601. variables.
  13602. </note>
  13603. </para>
  13604. </glossdef>
  13605. </glossentry>
  13606. <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm>
  13607. <info>
  13608. USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the useradd command if you wish to add a user to the system when the package is installed."
  13609. </info>
  13610. <glossdef>
  13611. <para role="glossdeffirst">
  13612. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13613. When inheriting the
  13614. <link linkend='ref-classes-useradd'><filename>useradd</filename></link>
  13615. class, this variable
  13616. specifies for a package what parameters should be passed
  13617. to the <filename>useradd</filename> command
  13618. if you wish to add a user to the system when the package
  13619. is installed.
  13620. </para>
  13621. <para>
  13622. Here is an example from the <filename>dbus</filename>
  13623. recipe:
  13624. <literallayout class='monospaced'>
  13625. USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \
  13626. --no-create-home --shell /bin/false \
  13627. --user-group messagebus"
  13628. </literallayout>
  13629. For information on the standard Linux shell command
  13630. <filename>useradd</filename>, see
  13631. <ulink url='http://linux.die.net/man/8/useradd'></ulink>.
  13632. </para>
  13633. </glossdef>
  13634. </glossentry>
  13635. <glossentry id='var-USERADD_UID_TABLES'><glossterm>USERADD_UID_TABLES</glossterm>
  13636. <info>
  13637. USERADD_UID_TABLES[doc] = "Specifies a password file to use for obtaining static user identification (uid) values when the OpenEmbedded build system adds a user to the system during package installation."
  13638. </info>
  13639. <glossdef>
  13640. <para role="glossdeffirst">
  13641. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13642. Specifies a password file to use for obtaining static
  13643. user identification (<filename>uid</filename>) values
  13644. when the OpenEmbedded build system adds a user to the
  13645. system during package installation.
  13646. </para>
  13647. <para>
  13648. When applying static user identification
  13649. (<filename>uid</filename>) values, the OpenEmbedded build
  13650. system looks in
  13651. <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
  13652. for a <filename>files/passwd</filename> file and then applies
  13653. those <filename>uid</filename> values.
  13654. Set the variable as follows in your
  13655. <filename>local.conf</filename> file:
  13656. <literallayout class='monospaced'>
  13657. USERADD_UID_TABLES = "files/passwd"
  13658. </literallayout>
  13659. </para>
  13660. <note>
  13661. Setting the
  13662. <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>
  13663. variable to "useradd-staticids" causes the build system
  13664. to use static <filename>uid</filename> values.
  13665. </note>
  13666. </glossdef>
  13667. </glossentry>
  13668. <glossentry id='var-USERADDEXTENSION'><glossterm>USERADDEXTENSION</glossterm>
  13669. <info>
  13670. USERADDEXTENSION[doc] = "When set to "useradd-staticids", causes the OpenEmbedded build system to base all user and group additions on a static passwd and group files found in BBPATH."
  13671. </info>
  13672. <glossdef>
  13673. <para role="glossdeffirst">
  13674. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13675. When set to "useradd-staticids", causes the
  13676. OpenEmbedded build system to base all user and group
  13677. additions on a static
  13678. <filename>passwd</filename> and
  13679. <filename>group</filename> files found in
  13680. <link linkend='var-BBPATH'><filename>BBPATH</filename></link>.
  13681. </para>
  13682. <para>
  13683. To use static user identification (<filename>uid</filename>)
  13684. and group identification (<filename>gid</filename>)
  13685. values, set the variable
  13686. as follows in your <filename>local.conf</filename> file:
  13687. <literallayout class='monospaced'>
  13688. USERADDEXTENSION = "useradd-staticids"
  13689. </literallayout>
  13690. <note>
  13691. Setting this variable to use static
  13692. <filename>uid</filename> and <filename>gid</filename>
  13693. values causes the OpenEmbedded build system to employ
  13694. the
  13695. <link linkend='ref-classes-useradd'><filename>useradd-staticids</filename></link>
  13696. class.
  13697. </note>
  13698. </para>
  13699. <para>
  13700. If you use static <filename>uid</filename> and
  13701. <filename>gid</filename> information, you must also
  13702. specify the <filename>files/passwd</filename> and
  13703. <filename>files/group</filename> files by setting the
  13704. <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>
  13705. and
  13706. <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>
  13707. variables.
  13708. Additionally, you should also set the
  13709. <link linkend='var-USERADD_ERROR_DYNAMIC'><filename>USERADD_ERROR_DYNAMIC</filename></link>
  13710. variable.
  13711. </para>
  13712. </glossdef>
  13713. </glossentry>
  13714. </glossdiv>
  13715. <!-- <glossdiv id='var-glossary-v'><title>V</title>-->
  13716. <!-- </glossdiv>-->
  13717. <glossdiv id='var-glossary-w'><title>W</title>
  13718. <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm>
  13719. <info>
  13720. WARN_QA[doc] = "Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system."
  13721. </info>
  13722. <glossdef>
  13723. <para role="glossdeffirst">
  13724. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13725. Specifies the quality assurance checks whose failures are
  13726. reported as warnings by the OpenEmbedded build system.
  13727. You set this variable in your distribution configuration
  13728. file.
  13729. For a list of the checks you can control with this variable,
  13730. see the
  13731. "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
  13732. section.
  13733. </para>
  13734. </glossdef>
  13735. </glossentry>
  13736. <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
  13737. <info>
  13738. WORKDIR[doc] = "The pathname of the working directory in which the OpenEmbedded build system builds a recipe. This directory is located within the TMPDIR directory structure and changes as different packages are built."
  13739. </info>
  13740. <glossdef>
  13741. <para role="glossdeffirst">
  13742. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13743. The pathname of the work directory in which the OpenEmbedded
  13744. build system builds a recipe.
  13745. This directory is located within the
  13746. <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
  13747. directory structure and is specific to the recipe being
  13748. built and the system for which it is being built.
  13749. </para>
  13750. <para>
  13751. The <filename>WORKDIR</filename> directory is defined as
  13752. follows:
  13753. <literallayout class='monospaced'>
  13754. ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
  13755. </literallayout>
  13756. The actual directory depends on several things:
  13757. <itemizedlist>
  13758. <listitem><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>:
  13759. The top-level build output directory</listitem>
  13760. <listitem><link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>:
  13761. The target system identifier</listitem>
  13762. <listitem><link linkend='var-PN'><filename>PN</filename></link>:
  13763. The recipe name</listitem>
  13764. <listitem><link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>:
  13765. The epoch - (if
  13766. <link linkend='var-PE'><filename>PE</filename></link>
  13767. is not specified, which is usually the case for most
  13768. recipes, then <filename>EXTENDPE</filename> is blank)</listitem>
  13769. <listitem><link linkend='var-PV'><filename>PV</filename></link>:
  13770. The recipe version</listitem>
  13771. <listitem><link linkend='var-PR'><filename>PR</filename></link>:
  13772. The recipe revision</listitem>
  13773. </itemizedlist>
  13774. </para>
  13775. <para>
  13776. As an example, assume a Source Directory top-level folder
  13777. name <filename>poky</filename>, a default Build Directory at
  13778. <filename>poky/build</filename>, and a
  13779. <filename>qemux86-poky-linux</filename> machine target
  13780. system.
  13781. Furthermore, suppose your recipe is named
  13782. <filename>foo_1.3.0-r0.bb</filename>.
  13783. In this case, the work directory the build system uses to
  13784. build the package would be as follows:
  13785. <literallayout class='monospaced'>
  13786. poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
  13787. </literallayout>
  13788. </para>
  13789. </glossdef>
  13790. </glossentry>
  13791. </glossdiv>
  13792. <glossdiv id='var-glossary-x'><title>X</title>
  13793. <glossentry id='var-XSERVER'><glossterm>XSERVER</glossterm>
  13794. <info>
  13795. XSERVER[doc] = "Specifies the packages that should be installed
  13796. to provide an X server and drivers for the current machine."
  13797. </info>
  13798. <glossdef>
  13799. <para role="glossdeffirst">
  13800. <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
  13801. Specifies the packages that should be installed to
  13802. provide an X server and drivers for the current machine,
  13803. assuming your image directly includes
  13804. <filename>packagegroup-core-x11-xserver</filename> or,
  13805. perhaps indirectly, includes "x11-base" in
  13806. <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
  13807. </para>
  13808. <para>
  13809. The default value of <filename>XSERVER</filename>, if not
  13810. specified in the machine configuration, is
  13811. "xserver-xorg xf86-video-fbdev xf86-input-evdev".
  13812. </para>
  13813. </glossdef>
  13814. </glossentry>
  13815. </glossdiv>
  13816. <!-- <glossdiv id='var-glossary-y'><title>Y</title>-->
  13817. <!-- </glossdiv>-->
  13818. <!-- <glossdiv id='var-glossary-z'><title>Z</title>-->
  13819. <!-- </glossdiv>-->
  13820. </glossary>
  13821. </chapter>
  13822. <!--
  13823. vim: expandtab tw=80 ts=4
  13824. -->