variables.rst 429 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047
  1. .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
  2. ******************
  3. Variables Glossary
  4. ******************
  5. This chapter lists common variables used in the OpenEmbedded build
  6. system and gives an overview of their function and contents.
  7. :term:`A <ABIEXTENSION>` :term:`B` :term:`C <CACHE>`
  8. :term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FEATURE_PACKAGES>`
  9. :term:`G <GCCPIE>` :term:`H <HOMEPAGE>` :term:`I <ICECC_DISABLED>`
  10. :term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
  11. :term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
  12. :term:`R <RANLIB>` :term:`S` :term:`T`
  13. :term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>`
  14. :term:`W <WARN_QA>` :term:`X <XSERVER>`
  15. .. glossary::
  16. :sorted:
  17. :term:`ABIEXTENSION`
  18. Extension to the Application Binary Interface (ABI) field of the GNU
  19. canonical architecture name (e.g. "eabi").
  20. ABI extensions are set in the machine include files. For example, the
  21. ``meta/conf/machine/include/arm/arch-arm.inc`` file sets the
  22. following extension::
  23. ABIEXTENSION = "eabi"
  24. :term:`ALLOW_EMPTY`
  25. Specifies whether to produce an output package even if it is empty.
  26. By default, BitBake does not produce empty packages. This default
  27. behavior can cause issues when there is an
  28. :term:`RDEPENDS` or some other hard runtime
  29. requirement on the existence of the package.
  30. Like all package-controlling variables, you must always use them in
  31. conjunction with a package name override, as in::
  32. ALLOW_EMPTY:${PN} = "1"
  33. ALLOW_EMPTY:${PN}-dev = "1"
  34. ALLOW_EMPTY:${PN}-staticdev = "1"
  35. :term:`ALTERNATIVE`
  36. Lists commands in a package that need an alternative binary naming
  37. scheme. Sometimes the same command is provided in multiple packages.
  38. When this occurs, the OpenEmbedded build system needs to use the
  39. alternatives system to create a different binary naming scheme so the
  40. commands can co-exist.
  41. To use the variable, list out the package's commands that are also
  42. provided by another package. For example, if the ``busybox`` package
  43. has four such commands, you identify them as follows::
  44. ALTERNATIVE:busybox = "sh sed test bracket"
  45. For more information on the alternatives system, see the
  46. ":ref:`ref-classes-update-alternatives`"
  47. section.
  48. :term:`ALTERNATIVE_LINK_NAME`
  49. Used by the alternatives system to map duplicated commands to actual
  50. locations. For example, if the ``bracket`` command provided by the
  51. ``busybox`` package is duplicated through another package, you must
  52. use the :term:`ALTERNATIVE_LINK_NAME` variable to specify the actual
  53. location::
  54. ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/["
  55. In this example, the binary for the ``bracket`` command (i.e. ``[``)
  56. from the ``busybox`` package resides in ``/usr/bin/``.
  57. .. note::
  58. If :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``.
  59. For more information on the alternatives system, see the
  60. ":ref:`ref-classes-update-alternatives`"
  61. section.
  62. :term:`ALTERNATIVE_PRIORITY`
  63. Used by the alternatives system to create default priorities for
  64. duplicated commands. You can use the variable to create a single
  65. default regardless of the command name or package, a default for
  66. specific duplicated commands regardless of the package, or a default
  67. for specific commands tied to particular packages. Here are the
  68. available syntax forms::
  69. ALTERNATIVE_PRIORITY = "priority"
  70. ALTERNATIVE_PRIORITY[name] = "priority"
  71. ALTERNATIVE_PRIORITY_pkg[name] = "priority"
  72. For more information on the alternatives system, see the
  73. ":ref:`ref-classes-update-alternatives`"
  74. section.
  75. :term:`ALTERNATIVE_TARGET`
  76. Used by the alternatives system to create default link locations for
  77. duplicated commands. You can use the variable to create a single
  78. default location for all duplicated commands regardless of the
  79. command name or package, a default for specific duplicated commands
  80. regardless of the package, or a default for specific commands tied to
  81. particular packages. Here are the available syntax forms::
  82. ALTERNATIVE_TARGET = "target"
  83. ALTERNATIVE_TARGET[name] = "target"
  84. ALTERNATIVE_TARGET_pkg[name] = "target"
  85. .. note::
  86. If :term:`ALTERNATIVE_TARGET` is not defined, it inherits the value
  87. from the :term:`ALTERNATIVE_LINK_NAME` variable.
  88. If :term:`ALTERNATIVE_LINK_NAME` and :term:`ALTERNATIVE_TARGET` are the
  89. same, the target for :term:`ALTERNATIVE_TARGET` has "``.{BPN}``"
  90. appended to it.
  91. Finally, if the file referenced has not been renamed, the
  92. alternatives system will rename it to avoid the need to rename
  93. alternative files in the :ref:`ref-tasks-install`
  94. task while retaining support for the command if necessary.
  95. For more information on the alternatives system, see the
  96. ":ref:`ref-classes-update-alternatives`" section.
  97. :term:`ANY_OF_DISTRO_FEATURES`
  98. When inheriting the :ref:`ref-classes-features_check`
  99. class, this variable identifies a list of distribution features where
  100. at least one must be enabled in the current configuration in order
  101. for the OpenEmbedded build system to build the recipe. In other words,
  102. if none of the features listed in :term:`ANY_OF_DISTRO_FEATURES`
  103. appear in :term:`DISTRO_FEATURES` within the current configuration, then
  104. the recipe will be skipped, and if the build system attempts to build
  105. the recipe then an error will be triggered.
  106. :term:`APPEND`
  107. An override list of append strings for each target specified with
  108. :term:`LABELS`.
  109. See the :ref:`ref-classes-grub-efi` class for more
  110. information on how this variable is used.
  111. :term:`AR`
  112. The minimal command and arguments used to run ``ar``.
  113. :term:`ARCHIVER_MODE`
  114. When used with the :ref:`ref-classes-archiver` class,
  115. determines the type of information used to create a released archive.
  116. You can use this variable to create archives of patched source,
  117. original source, configured source, and so forth by employing the
  118. following variable flags (varflags)::
  119. ARCHIVER_MODE[src] = "original" # Uses original (unpacked) source files.
  120. ARCHIVER_MODE[src] = "patched" # Uses patched source files. This is the default.
  121. ARCHIVER_MODE[src] = "configured" # Uses configured source files.
  122. ARCHIVER_MODE[diff] = "1" # Uses patches between do_unpack and do_patch.
  123. ARCHIVER_MODE[diff-exclude] ?= "file file ..." # Lists files and directories to exclude from diff.
  124. ARCHIVER_MODE[dumpdata] = "1" # Uses environment data.
  125. ARCHIVER_MODE[recipe] = "1" # Uses recipe and include files.
  126. ARCHIVER_MODE[srpm] = "1" # Uses RPM package files.
  127. For information on how the variable works, see the
  128. ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`.
  129. :term:`AS`
  130. Minimal command and arguments needed to run the assembler.
  131. :term:`ASSUME_PROVIDED`
  132. Lists recipe names (:term:`PN` values) BitBake does not
  133. attempt to build. Instead, BitBake assumes these recipes have already
  134. been built.
  135. In OpenEmbedded-Core, :term:`ASSUME_PROVIDED` mostly specifies native
  136. tools that should not be built. An example is ``git-native``, which
  137. when specified, allows for the Git binary from the host to be used
  138. rather than building ``git-native``.
  139. :term:`ASSUME_SHLIBS`
  140. Provides additional ``shlibs`` provider mapping information, which
  141. adds to or overwrites the information provided automatically by the
  142. system. Separate multiple entries using spaces.
  143. As an example, use the following form to add an ``shlib`` provider of
  144. shlibname in packagename with the optional version::
  145. shlibname:packagename[_version]
  146. Here is an example that adds a shared library named ``libEGL.so.1``
  147. as being provided by the ``libegl-implementation`` package::
  148. ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation"
  149. :term:`AUTO_LIBNAME_PKGS`
  150. When the :ref:`ref-classes-debian` class is inherited,
  151. which is the default behavior, :term:`AUTO_LIBNAME_PKGS` specifies which
  152. packages should be checked for libraries and renamed according to
  153. Debian library package naming.
  154. The default value is "${PACKAGES}", which causes the
  155. :ref:`ref-classes-debian` class to act on all packages that are
  156. explicitly generated by the recipe.
  157. :term:`AUTOREV`
  158. When :term:`SRCREV` is set to the value of this variable, it specifies to
  159. use the latest source revision in the repository. Here is an example::
  160. SRCREV = "${AUTOREV}"
  161. If you use the previous statement to retrieve the latest version of
  162. software, you need to be sure :term:`PV` contains
  163. ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel
  164. recipe that inherits the :ref:`ref-classes-kernel` class and you
  165. use the previous statement. In this example, ``${SRCPV}`` does not
  166. automatically get into :term:`PV`. Consequently, you need to change
  167. :term:`PV` in your recipe so that it does contain ``${SRCPV}``.
  168. For more information see the
  169. ":ref:`dev-manual/packages:automatically incrementing a package version number`"
  170. section in the Yocto Project Development Tasks Manual.
  171. :term:`AUTO_SYSLINUXMENU`
  172. Enables creating an automatic menu for the syslinux bootloader. You
  173. must set this variable in your recipe. The
  174. :ref:`ref-classes-syslinux` class checks this variable.
  175. :term:`AVAILTUNES`
  176. The list of defined CPU and Application Binary Interface (ABI)
  177. tunings (i.e. "tunes") available for use by the OpenEmbedded build
  178. system.
  179. The list simply presents the tunes that are available. Not all tunes
  180. may be compatible with a particular machine configuration, or with
  181. each other in a
  182. :ref:`Multilib <dev-manual/libraries:combining multiple versions of library files into one image>`
  183. configuration.
  184. To add a tune to the list, be sure to append it with spaces using the
  185. "+=" BitBake operator. Do not simply replace the list by using the
  186. "=" operator. See the
  187. ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section in the BitBake
  188. User Manual for more information.
  189. :term:`AZ_SAS`
  190. Azure Storage Shared Access Signature, when using the
  191. :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
  192. This variable can be defined to be used by the fetcher to authenticate
  193. and gain access to non-public artifacts::
  194. AZ_SAS = ""se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>""
  195. For more information see Microsoft's Azure Storage documentation at
  196. https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview
  197. :term:`B`
  198. The directory within the :term:`Build Directory` in which the
  199. OpenEmbedded build system places generated objects during a recipe's
  200. build process. By default, this directory is the same as the
  201. :term:`S` directory, which is defined as::
  202. S = "${WORKDIR}/${BP}"
  203. You can separate the (:term:`S`) directory and the directory pointed to
  204. by the :term:`B` variable. Most Autotools-based recipes support
  205. separating these directories. The build system defaults to using
  206. separate directories for ``gcc`` and some kernel recipes.
  207. :term:`BAD_RECOMMENDATIONS`
  208. Lists "recommended-only" packages to not install. Recommended-only
  209. packages are packages installed only through the
  210. :term:`RRECOMMENDS` variable. You can prevent any
  211. of these "recommended" packages from being installed by listing them
  212. with the :term:`BAD_RECOMMENDATIONS` variable::
  213. BAD_RECOMMENDATIONS = "package_name package_name package_name ..."
  214. You can set this variable globally in your ``local.conf`` file or you
  215. can attach it to a specific image recipe by using the recipe name
  216. override::
  217. BAD_RECOMMENDATIONS:pn-target_image = "package_name"
  218. It is important to realize that if you choose to not install packages
  219. using this variable and some other packages are dependent on them
  220. (i.e. listed in a recipe's :term:`RDEPENDS`
  221. variable), the OpenEmbedded build system ignores your request and
  222. will install the packages to avoid dependency errors.
  223. This variable is supported only when using the IPK and RPM
  224. packaging backends. DEB is not supported.
  225. See the :term:`NO_RECOMMENDATIONS` and the
  226. :term:`PACKAGE_EXCLUDE` variables for related
  227. information.
  228. :term:`BASE_LIB`
  229. The library directory name for the CPU or Application Binary
  230. Interface (ABI) tune. The :term:`BASE_LIB` applies only in the Multilib
  231. context. See the ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`"
  232. section in the Yocto Project Development Tasks Manual for information
  233. on Multilib.
  234. The :term:`BASE_LIB` variable is defined in the machine include files in
  235. the :term:`Source Directory`. If Multilib is not
  236. being used, the value defaults to "lib".
  237. :term:`BASE_WORKDIR`
  238. Points to the base of the work directory for all recipes. The default
  239. value is "${TMPDIR}/work".
  240. :term:`BB_ALLOWED_NETWORKS`
  241. Specifies a space-delimited list of hosts that the fetcher is allowed
  242. to use to obtain the required source code. Here are
  243. considerations surrounding this variable:
  244. - This host list is only used if :term:`BB_NO_NETWORK` is either not set
  245. or set to "0".
  246. - There is limited support for wildcard matching against the beginning of
  247. host names. For example, the following setting matches
  248. ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``::
  249. BB_ALLOWED_NETWORKS = "*.gnu.org"
  250. .. note::
  251. The use of the "``*``" character only works at the beginning of
  252. a host name and it must be isolated from the remainder of the
  253. host name. You cannot use the wildcard character in any other
  254. location of the name or combined with the front part of the
  255. name.
  256. For example, ``*.foo.bar`` is supported, while ``*aa.foo.bar``
  257. is not.
  258. - Mirrors not in the host list are skipped and logged in debug.
  259. - Attempts to access networks not in the host list cause a failure.
  260. Using :term:`BB_ALLOWED_NETWORKS` in conjunction with
  261. :term:`PREMIRRORS` is very useful. Adding the host
  262. you want to use to :term:`PREMIRRORS` results in the source code being
  263. fetched from an allowed location and avoids raising an error when a
  264. host that is not allowed is in a :term:`SRC_URI`
  265. statement. This is because the fetcher does not attempt to use the
  266. host listed in :term:`SRC_URI` after a successful fetch from the
  267. :term:`PREMIRRORS` occurs.
  268. :term:`BB_BASEHASH_IGNORE_VARS`
  269. See :term:`bitbake:BB_BASEHASH_IGNORE_VARS` in the BitBake manual.
  270. :term:`BB_CACHEDIR`
  271. See :term:`bitbake:BB_CACHEDIR` in the BitBake manual.
  272. :term:`BB_CHECK_SSL_CERTS`
  273. See :term:`bitbake:BB_CHECK_SSL_CERTS` in the BitBake manual.
  274. :term:`BB_CONSOLELOG`
  275. See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual.
  276. :term:`BB_CURRENTTASK`
  277. See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual.
  278. :term:`BB_DANGLINGAPPENDS_WARNONLY`
  279. Defines how BitBake handles situations where an append file
  280. (``.bbappend``) has no corresponding recipe file (``.bb``). This
  281. condition often occurs when layers get out of sync (e.g. ``oe-core``
  282. bumps a recipe version and the old recipe no longer exists and the
  283. other layer has not been updated to the new version of the recipe
  284. yet).
  285. The default fatal behavior is safest because it is the sane reaction
  286. given something is out of sync. It is important to realize when your
  287. changes are no longer being applied.
  288. You can change the default behavior by setting this variable to "1",
  289. "yes", or "true" in your ``local.conf`` file, which is located in the
  290. :term:`Build Directory`: Here is an example::
  291. BB_DANGLINGAPPENDS_WARNONLY = "1"
  292. :term:`BB_DEFAULT_TASK`
  293. See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual.
  294. :term:`BB_DEFAULT_UMASK`
  295. See :term:`bitbake:BB_DEFAULT_UMASK` in the BitBake manual.
  296. :term:`BB_DISKMON_DIRS`
  297. Monitors disk space and available inodes during the build and allows
  298. you to control the build based on these parameters.
  299. Disk space monitoring is disabled by default. To enable monitoring,
  300. add the :term:`BB_DISKMON_DIRS` variable to your ``conf/local.conf`` file
  301. found in the :term:`Build Directory`. Use the
  302. following form:
  303. .. code-block:: none
  304. BB_DISKMON_DIRS = "action,dir,threshold [...]"
  305. where:
  306. action is:
  307. ABORT: Immediately stop the build when
  308. a threshold is broken.
  309. STOPTASKS: Stop the build after the currently
  310. executing tasks have finished when
  311. a threshold is broken.
  312. WARN: Issue a warning but continue the
  313. build when a threshold is broken.
  314. Subsequent warnings are issued as
  315. defined by the BB_DISKMON_WARNINTERVAL
  316. variable, which must be defined in
  317. the conf/local.conf file.
  318. dir is:
  319. Any directory you choose. You can specify one or
  320. more directories to monitor by separating the
  321. groupings with a space. If two directories are
  322. on the same device, only the first directory
  323. is monitored.
  324. threshold is:
  325. Either the minimum available disk space,
  326. the minimum number of free inodes, or
  327. both. You must specify at least one. To
  328. omit one or the other, simply omit the value.
  329. Specify the threshold using G, M, K for Gbytes,
  330. Mbytes, and Kbytes, respectively. If you do
  331. not specify G, M, or K, Kbytes is assumed by
  332. default. Do not use GB, MB, or KB.
  333. Here are some examples::
  334. BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K"
  335. BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G"
  336. BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
  337. The first example works only if you also provide the
  338. :term:`BB_DISKMON_WARNINTERVAL`
  339. variable in the ``conf/local.conf``. This example causes the build
  340. system to immediately stop when either the disk space in
  341. ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops
  342. below 100 Kbytes. Because two directories are provided with the
  343. variable, the build system also issue a warning when the disk space
  344. in the ``${SSTATE_DIR}`` directory drops below 1 Gbyte or the number
  345. of free inodes drops below 100 Kbytes. Subsequent warnings are issued
  346. during intervals as defined by the :term:`BB_DISKMON_WARNINTERVAL`
  347. variable.
  348. The second example stops the build after all currently executing
  349. tasks complete when the minimum disk space in the ``${TMPDIR}``
  350. directory drops below 1 Gbyte. No disk monitoring occurs for the free
  351. inodes in this case.
  352. The final example immediately stops the build when the number of
  353. free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No
  354. disk space monitoring for the directory itself occurs in this case.
  355. :term:`BB_DISKMON_WARNINTERVAL`
  356. Defines the disk space and free inode warning intervals. To set these
  357. intervals, define the variable in your ``conf/local.conf`` file in
  358. the :term:`Build Directory`.
  359. If you are going to use the :term:`BB_DISKMON_WARNINTERVAL` variable, you
  360. must also use the :term:`BB_DISKMON_DIRS`
  361. variable and define its action as "WARN". During the build,
  362. subsequent warnings are issued each time disk space or number of free
  363. inodes further reduces by the respective interval.
  364. If you do not provide a :term:`BB_DISKMON_WARNINTERVAL` variable and you
  365. do use :term:`BB_DISKMON_DIRS` with the "WARN" action, the disk
  366. monitoring interval defaults to the following::
  367. BB_DISKMON_WARNINTERVAL = "50M,5K"
  368. When specifying the variable in your configuration file, use the
  369. following form:
  370. .. code-block:: none
  371. BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval"
  372. where:
  373. disk_space_interval is:
  374. An interval of memory expressed in either
  375. G, M, or K for Gbytes, Mbytes, or Kbytes,
  376. respectively. You cannot use GB, MB, or KB.
  377. disk_inode_interval is:
  378. An interval of free inodes expressed in either
  379. G, M, or K for Gbytes, Mbytes, or Kbytes,
  380. respectively. You cannot use GB, MB, or KB.
  381. Here is an example::
  382. BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
  383. BB_DISKMON_WARNINTERVAL = "50M,5K"
  384. These variables cause the
  385. OpenEmbedded build system to issue subsequent warnings each time the
  386. available disk space further reduces by 50 Mbytes or the number of
  387. free inodes further reduces by 5 Kbytes in the ``${SSTATE_DIR}``
  388. directory. Subsequent warnings based on the interval occur each time
  389. a respective interval is reached beyond the initial warning (i.e. 1
  390. Gbytes and 100 Kbytes).
  391. :term:`BB_ENV_PASSTHROUGH`
  392. See :term:`bitbake:BB_ENV_PASSTHROUGH` in the BitBake manual.
  393. :term:`BB_ENV_PASSTHROUGH_ADDITIONS`
  394. See :term:`bitbake:BB_ENV_PASSTHROUGH_ADDITIONS` in the BitBake manual.
  395. :term:`BB_FETCH_PREMIRRORONLY`
  396. See :term:`bitbake:BB_FETCH_PREMIRRORONLY` in the BitBake manual.
  397. :term:`BB_FILENAME`
  398. See :term:`bitbake:BB_FILENAME` in the BitBake manual.
  399. :term:`BB_GENERATE_MIRROR_TARBALLS`
  400. Causes tarballs of the source control repositories (e.g. Git
  401. repositories), including metadata, to be placed in the
  402. :term:`DL_DIR` directory.
  403. For performance reasons, creating and placing tarballs of these
  404. repositories is not the default action by the OpenEmbedded build
  405. system::
  406. BB_GENERATE_MIRROR_TARBALLS = "1"
  407. Set this variable in your
  408. ``local.conf`` file in the :term:`Build Directory`.
  409. Once you have the tarballs containing your source files, you can
  410. clean up your :term:`DL_DIR` directory by deleting any Git or other
  411. source control work directories.
  412. :term:`BB_GENERATE_SHALLOW_TARBALLS`
  413. See :term:`bitbake:BB_GENERATE_SHALLOW_TARBALLS` in the BitBake manual.
  414. :term:`BB_GIT_SHALLOW`
  415. See :term:`bitbake:BB_GIT_SHALLOW` in the BitBake manual.
  416. :term:`BB_GIT_SHALLOW_DEPTH`
  417. See :term:`bitbake:BB_GIT_SHALLOW_DEPTH` in the BitBake manual.
  418. :term:`BB_HASHCHECK_FUNCTION`
  419. See :term:`bitbake:BB_HASHCHECK_FUNCTION` in the BitBake manual.
  420. :term:`BB_HASHCONFIG_IGNORE_VARS`
  421. See :term:`bitbake:BB_HASHCONFIG_IGNORE_VARS` in the BitBake manual.
  422. :term:`BB_HASHSERVE`
  423. See :term:`bitbake:BB_HASHSERVE` in the BitBake manual.
  424. :term:`BB_HASHSERVE_UPSTREAM`
  425. See :term:`bitbake:BB_HASHSERVE_UPSTREAM` in the BitBake manual.
  426. :term:`BB_INVALIDCONF`
  427. See :term:`bitbake:BB_INVALIDCONF` in the BitBake manual.
  428. :term:`BB_LOGCONFIG`
  429. See :term:`bitbake:BB_LOGCONFIG` in the BitBake manual.
  430. :term:`BB_LOGFMT`
  431. See :term:`bitbake:BB_LOGFMT` in the BitBake manual.
  432. :term:`BB_MULTI_PROVIDER_ALLOWED`
  433. See :term:`bitbake:BB_MULTI_PROVIDER_ALLOWED` in the BitBake manual.
  434. :term:`BB_NICE_LEVEL`
  435. See :term:`bitbake:BB_NICE_LEVEL` in the BitBake manual.
  436. :term:`BB_NO_NETWORK`
  437. See :term:`bitbake:BB_NO_NETWORK` in the BitBake manual.
  438. :term:`BB_NUMBER_PARSE_THREADS`
  439. See :term:`bitbake:BB_NUMBER_PARSE_THREADS` in the BitBake manual.
  440. :term:`BB_NUMBER_THREADS`
  441. The maximum number of tasks BitBake should run in parallel at any one
  442. time. The OpenEmbedded build system automatically configures this
  443. variable to be equal to the number of cores on the build system. For
  444. example, a system with a dual core processor that also uses
  445. hyper-threading causes the :term:`BB_NUMBER_THREADS` variable to default
  446. to "4".
  447. For single socket systems (i.e. one CPU), you should not have to
  448. override this variable to gain optimal parallelism during builds.
  449. However, if you have very large systems that employ multiple physical
  450. CPUs, you might want to make sure the :term:`BB_NUMBER_THREADS` variable
  451. is not set higher than "20".
  452. For more information on speeding up builds, see the
  453. ":ref:`dev-manual/speeding-up-build:speeding up a build`"
  454. section in the Yocto Project Development Tasks Manual.
  455. On the other hand, if your goal is to limit the amount of system
  456. resources consumed by BitBake tasks, setting :term:`BB_NUMBER_THREADS`
  457. to a number lower than the number of CPU threads in your machine
  458. won't be sufficient. That's because each package will still be built
  459. and installed through a number of parallel jobs specified by the
  460. :term:`PARALLEL_MAKE` variable, which is by default the number of CPU
  461. threads in your system, and is not impacted by the
  462. :term:`BB_NUMBER_THREADS` value.
  463. So, if you set :term:`BB_NUMBER_THREADS` to "1" but don't set
  464. :term:`PARALLEL_MAKE`, most of your system resources will be consumed
  465. anyway.
  466. Therefore, if you intend to reduce the load of your build system by
  467. setting :term:`BB_NUMBER_THREADS` to a relatively low value compared
  468. to the number of CPU threads on your system, you should also set
  469. :term:`PARALLEL_MAKE` to a similarly low value.
  470. An alternative to using :term:`BB_NUMBER_THREADS` to keep the usage
  471. of build system resources under control is to use the smarter
  472. :term:`BB_PRESSURE_MAX_CPU`, :term:`BB_PRESSURE_MAX_IO` or
  473. :term:`BB_PRESSURE_MAX_MEMORY` controls. They will prevent BitBake
  474. from starting new tasks as long as thresholds are exceeded. Anyway,
  475. as with :term:`BB_NUMBER_THREADS`, such controls won't prevent the
  476. tasks already being run from using all CPU threads on the system
  477. if :term:`PARALLEL_MAKE` is not set to a low value.
  478. :term:`BB_ORIGENV`
  479. See :term:`bitbake:BB_ORIGENV` in the BitBake manual.
  480. :term:`BB_PRESERVE_ENV`
  481. See :term:`bitbake:BB_PRESERVE_ENV` in the BitBake manual.
  482. :term:`BB_PRESSURE_MAX_CPU`
  483. See :term:`bitbake:BB_PRESSURE_MAX_CPU` in the BitBake manual.
  484. :term:`BB_PRESSURE_MAX_IO`
  485. See :term:`bitbake:BB_PRESSURE_MAX_IO` in the BitBake manual.
  486. :term:`BB_PRESSURE_MAX_MEMORY`
  487. See :term:`bitbake:BB_PRESSURE_MAX_MEMORY` in the BitBake manual.
  488. :term:`BB_RUNFMT`
  489. See :term:`bitbake:BB_RUNFMT` in the BitBake manual.
  490. :term:`BB_RUNTASK`
  491. See :term:`bitbake:BB_RUNTASK` in the BitBake manual.
  492. :term:`BB_SCHEDULER`
  493. See :term:`bitbake:BB_SCHEDULER` in the BitBake manual.
  494. :term:`BB_SCHEDULERS`
  495. See :term:`bitbake:BB_SCHEDULERS` in the BitBake manual.
  496. :term:`BB_SERVER_TIMEOUT`
  497. Specifies the time (in seconds) after which to unload the BitBake
  498. server due to inactivity. Set :term:`BB_SERVER_TIMEOUT` to determine how
  499. long the BitBake server stays resident between invocations.
  500. For example, the following statement in your ``local.conf`` file
  501. instructs the server to be unloaded after 20 seconds of inactivity::
  502. BB_SERVER_TIMEOUT = "20"
  503. If you want the server to never be unloaded,
  504. set :term:`BB_SERVER_TIMEOUT` to "-1".
  505. :term:`BB_SETSCENE_DEPVALID`
  506. See :term:`bitbake:BB_SETSCENE_DEPVALID` in the BitBake manual.
  507. :term:`BB_SIGNATURE_EXCLUDE_FLAGS`
  508. See :term:`bitbake:BB_SIGNATURE_EXCLUDE_FLAGS` in the BitBake manual.
  509. :term:`BB_SIGNATURE_HANDLER`
  510. See :term:`bitbake:BB_SIGNATURE_HANDLER` in the BitBake manual.
  511. :term:`BB_SRCREV_POLICY`
  512. See :term:`bitbake:BB_SRCREV_POLICY` in the BitBake manual.
  513. :term:`BB_STRICT_CHECKSUM`
  514. See :term:`bitbake:BB_STRICT_CHECKSUM` in the BitBake manual.
  515. :term:`BB_TASK_IONICE_LEVEL`
  516. See :term:`bitbake:BB_TASK_IONICE_LEVEL` in the BitBake manual.
  517. :term:`BB_TASK_NICE_LEVEL`
  518. See :term:`bitbake:BB_TASK_NICE_LEVEL` in the BitBake manual.
  519. :term:`BB_TASKHASH`
  520. See :term:`bitbake:BB_TASKHASH` in the BitBake manual.
  521. :term:`BB_VERBOSE_LOGS`
  522. See :term:`bitbake:BB_VERBOSE_LOGS` in the BitBake manual.
  523. :term:`BB_WORKERCONTEXT`
  524. See :term:`bitbake:BB_WORKERCONTEXT` in the BitBake manual.
  525. :term:`BBCLASSEXTEND`
  526. Allows you to extend a recipe so that it builds variants of the
  527. software. There are common variants for recipes as "natives" like
  528. ``quilt-native``, which is a copy of Quilt built to run on the build
  529. system; "crosses" such as ``gcc-cross``, which is a compiler built to
  530. run on the build machine but produces binaries that run on the target
  531. :term:`MACHINE`; ":ref:`ref-classes-nativesdk`", which
  532. targets the SDK machine instead of :term:`MACHINE`; and "mulitlibs" in
  533. the form "``multilib:``\ multilib_name".
  534. To build a different variant of the recipe with a minimal amount of
  535. code, it usually is as simple as adding the following to your recipe::
  536. BBCLASSEXTEND =+ "native nativesdk"
  537. BBCLASSEXTEND =+ "multilib:multilib_name"
  538. .. note::
  539. Internally, the :term:`BBCLASSEXTEND` mechanism generates recipe
  540. variants by rewriting variable values and applying overrides such
  541. as ``:class-native``. For example, to generate a native version of
  542. a recipe, a :term:`DEPENDS` on "foo" is rewritten
  543. to a :term:`DEPENDS` on "foo-native".
  544. Even when using :term:`BBCLASSEXTEND`, the recipe is only parsed once.
  545. Parsing once adds some limitations. For example, it is not
  546. possible to include a different file depending on the variant,
  547. since ``include`` statements are processed when the recipe is
  548. parsed.
  549. :term:`BBDEBUG`
  550. See :term:`bitbake:BBDEBUG` in the BitBake manual.
  551. :term:`BBFILE_COLLECTIONS`
  552. Lists the names of configured layers. These names are used to find
  553. the other ``BBFILE_*`` variables. Typically, each layer will append
  554. its name to this variable in its ``conf/layer.conf`` file.
  555. :term:`BBFILE_PATTERN`
  556. Variable that expands to match files from
  557. :term:`BBFILES` in a particular layer. This variable
  558. is used in the ``conf/layer.conf`` file and must be suffixed with the
  559. name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``).
  560. :term:`BBFILE_PRIORITY`
  561. Assigns the priority for recipe files in each layer.
  562. This variable is useful in situations where the same recipe appears
  563. in more than one layer. Setting this variable allows you to
  564. prioritize a layer against other layers that contain the same recipe
  565. --- effectively letting you control the precedence for the multiple
  566. layers. The precedence established through this variable stands
  567. regardless of a recipe's version (:term:`PV` variable). For
  568. example, a layer that has a recipe with a higher :term:`PV` value but for
  569. which the :term:`BBFILE_PRIORITY` is set to have a lower precedence still
  570. has a lower precedence.
  571. A larger value for the :term:`BBFILE_PRIORITY` variable results in a
  572. higher precedence. For example, the value 6 has a higher precedence
  573. than the value 5. If not specified, the :term:`BBFILE_PRIORITY` variable
  574. is set based on layer dependencies (see the :term:`LAYERDEPENDS` variable
  575. for more information. The default priority, if unspecified for a
  576. layer with no dependencies, is the lowest defined priority + 1 (or 1
  577. if no priorities are defined).
  578. .. tip::
  579. You can use the command ``bitbake-layers show-layers``
  580. to list all configured layers along with their priorities.
  581. :term:`BBFILES`
  582. A space-separated list of recipe files BitBake uses to build
  583. software.
  584. When specifying recipe files, you can pattern match using Python's
  585. `glob <https://docs.python.org/3/library/glob.html>`__ syntax.
  586. For details on the syntax, see the documentation by following the
  587. previous link.
  588. :term:`BBFILES_DYNAMIC`
  589. Activates content when identified layers are present. You identify
  590. the layers by the collections that the layers define.
  591. Use the :term:`BBFILES_DYNAMIC` variable to avoid ``.bbappend`` files
  592. whose corresponding ``.bb`` file is in a layer that attempts to
  593. modify other layers through ``.bbappend`` but does not want to
  594. introduce a hard dependency on those other layers.
  595. Use the following form for :term:`BBFILES_DYNAMIC`:
  596. ``collection_name:filename_pattern``.
  597. The following example identifies two collection names and two
  598. filename patterns::
  599. BBFILES_DYNAMIC += " \
  600. clang-layer:${LAYERDIR}/bbappends/meta-clang/*/*/*.bbappend \
  601. core:${LAYERDIR}/bbappends/openembedded-core/meta/*/*/*.bbappend \
  602. "
  603. This next example shows an error message that occurs because invalid
  604. entries are found, which cause parsing to fail:
  605. .. code-block:: none
  606. ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not:
  607. /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend
  608. /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend
  609. :term:`BBINCLUDED`
  610. See :term:`bitbake:BBINCLUDED` in the BitBake manual.
  611. :term:`BBINCLUDELOGS`
  612. Variable that controls how BitBake displays logs on build failure.
  613. :term:`BBINCLUDELOGS_LINES`
  614. If :term:`BBINCLUDELOGS` is set, specifies the
  615. maximum number of lines from the task log file to print when
  616. reporting a failed task. If you do not set :term:`BBINCLUDELOGS_LINES`,
  617. the entire log is printed.
  618. :term:`BBLAYERS`
  619. Lists the layers to enable during the build. This variable is defined
  620. in the ``bblayers.conf`` configuration file in the :term:`Build Directory`.
  621. Here is an example::
  622. BBLAYERS = " \
  623. /home/scottrif/poky/meta \
  624. /home/scottrif/poky/meta-poky \
  625. /home/scottrif/poky/meta-yocto-bsp \
  626. /home/scottrif/poky/meta-mykernel \
  627. "
  628. This example enables four layers, one of which is a custom,
  629. user-defined layer named ``meta-mykernel``.
  630. :term:`BBLAYERS_FETCH_DIR`
  631. See :term:`bitbake:BBLAYERS_FETCH_DIR` in the BitBake manual.
  632. :term:`BBMASK`
  633. Prevents BitBake from processing recipes and recipe append files.
  634. You can use the :term:`BBMASK` variable to "hide" these ``.bb`` and
  635. ``.bbappend`` files. BitBake ignores any recipe or recipe append
  636. files that match any of the expressions. It is as if BitBake does not
  637. see them at all. Consequently, matching files are not parsed or
  638. otherwise used by BitBake.
  639. The values you provide are passed to Python's regular expression
  640. compiler. Consequently, the syntax follows Python's Regular
  641. Expression (re) syntax. The expressions are compared against the full
  642. paths to the files. For complete syntax information, see Python's
  643. documentation at https://docs.python.org/3/library/re.html#regular-expression-syntax.
  644. The following example uses a complete regular expression to tell
  645. BitBake to ignore all recipe and recipe append files in the
  646. ``meta-ti/recipes-misc/`` directory::
  647. BBMASK = "meta-ti/recipes-misc/"
  648. If you want to mask out multiple directories or recipes, you can
  649. specify multiple regular expression fragments. This next example
  650. masks out multiple directories and individual recipes::
  651. BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/"
  652. BBMASK += "/meta-oe/recipes-support/"
  653. BBMASK += "/meta-foo/.*/openldap"
  654. BBMASK += "opencv.*\.bbappend"
  655. BBMASK += "lzma"
  656. .. note::
  657. When specifying a directory name, use the trailing slash character
  658. to ensure you match just that directory name.
  659. :term:`BBMULTICONFIG`
  660. Specifies each additional separate configuration when you are
  661. building targets with multiple configurations. Use this variable in
  662. your ``conf/local.conf`` configuration file. Specify a
  663. multiconfigname for each configuration file you are using. For
  664. example, the following line specifies three configuration files::
  665. BBMULTICONFIG = "configA configB configC"
  666. Each configuration file you use must reside in a ``multiconfig``
  667. subdirectory of a configuration directory within a layer, or
  668. within the :term:`Build Directory` (e.g.
  669. ``build_directory/conf/multiconfig/configA.conf`` or
  670. ``mylayer/conf/multiconfig/configB.conf``).
  671. For information on how to use :term:`BBMULTICONFIG` in an environment
  672. that supports building targets with multiple configurations, see the
  673. ":ref:`dev-manual/building:building images for multiple targets using multiple configurations`"
  674. section in the Yocto Project Development Tasks Manual.
  675. :term:`BBPATH`
  676. See :term:`bitbake:BBPATH` in the BitBake manual.
  677. :term:`BBSERVER`
  678. If defined in the BitBake environment, :term:`BBSERVER` points to the
  679. BitBake remote server.
  680. Use the following format to export the variable to the BitBake
  681. environment::
  682. export BBSERVER=localhost:$port
  683. By default, :term:`BBSERVER` also appears in :term:`BB_BASEHASH_IGNORE_VARS`.
  684. Consequently, :term:`BBSERVER` is excluded from checksum and dependency
  685. data.
  686. :term:`BBTARGETS`
  687. See :term:`bitbake:BBTARGETS` in the BitBake manual.
  688. :term:`BINCONFIG`
  689. When inheriting the :ref:`ref-classes-binconfig-disabled` class, this
  690. variable specifies binary configuration scripts to disable in favor of
  691. using ``pkg-config`` to query the information. The
  692. :ref:`ref-classes-binconfig-disabled` class will modify the specified
  693. scripts to return an error so that calls to them can be easily found
  694. and replaced.
  695. To add multiple scripts, separate them by spaces. Here is an example
  696. from the ``libpng`` recipe::
  697. BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config"
  698. :term:`BINCONFIG_GLOB`
  699. When inheriting the :ref:`ref-classes-binconfig` class,
  700. this variable specifies a wildcard for configuration scripts that
  701. need editing. The scripts are edited to correct any paths that have
  702. been set up during compilation so that they are correct for use when
  703. installed into the sysroot and called by the build processes of other
  704. recipes.
  705. .. note::
  706. The :term:`BINCONFIG_GLOB` variable uses
  707. `shell globbing <https://tldp.org/LDP/abs/html/globbingref.html>`__,
  708. which is recognition and expansion of wildcards during pattern
  709. matching. Shell globbing is very similar to
  710. `fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__
  711. and `glob <https://docs.python.org/3/library/glob.html>`__.
  712. For more information on how this variable works, see
  713. ``meta/classes-recipe/binconfig.bbclass`` in the :term:`Source Directory`.
  714. You can also find general
  715. information on the class in the
  716. ":ref:`ref-classes-binconfig`" section.
  717. :term:`BITBAKE_UI`
  718. See :term:`bitbake:BITBAKE_UI` in the BitBake manual.
  719. :term:`BP`
  720. The base recipe name and version but without any special recipe name
  721. suffix (i.e. ``-native``, ``lib64-``, and so forth). :term:`BP` is
  722. comprised of the following::
  723. ${BPN}-${PV}
  724. :term:`BPN`
  725. This variable is a version of the :term:`PN` variable with
  726. common prefixes and suffixes removed, such as ``nativesdk-``,
  727. ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``.
  728. The exact lists of prefixes and suffixes removed are specified by the
  729. :term:`MLPREFIX` and
  730. :term:`SPECIAL_PKGSUFFIX` variables,
  731. respectively.
  732. :term:`BUGTRACKER`
  733. Specifies a URL for an upstream bug tracking website for a recipe.
  734. The OpenEmbedded build system does not use this variable. Rather, the
  735. variable is a useful pointer in case a bug in the software being
  736. built needs to be manually reported.
  737. :term:`BUILD_ARCH`
  738. Specifies the architecture of the build host (e.g. ``i686``). The
  739. OpenEmbedded build system sets the value of :term:`BUILD_ARCH` from the
  740. machine name reported by the ``uname`` command.
  741. :term:`BUILD_AS_ARCH`
  742. Specifies the architecture-specific assembler flags for the build
  743. host. By default, the value of :term:`BUILD_AS_ARCH` is empty.
  744. :term:`BUILD_CC_ARCH`
  745. Specifies the architecture-specific C compiler flags for the build
  746. host. By default, the value of :term:`BUILD_CC_ARCH` is empty.
  747. :term:`BUILD_CCLD`
  748. Specifies the linker command to be used for the build host when the C
  749. compiler is being used as the linker. By default, :term:`BUILD_CCLD`
  750. points to GCC and passes as arguments the value of
  751. :term:`BUILD_CC_ARCH`, assuming
  752. :term:`BUILD_CC_ARCH` is set.
  753. :term:`BUILD_CFLAGS`
  754. Specifies the flags to pass to the C compiler when building for the
  755. build host. When building in the ``-native`` context,
  756. :term:`CFLAGS` is set to the value of this variable by
  757. default.
  758. :term:`BUILD_CPPFLAGS`
  759. Specifies the flags to pass to the C preprocessor (i.e. to both the C
  760. and the C++ compilers) when building for the build host. When
  761. building in the ``-native`` context, :term:`CPPFLAGS`
  762. is set to the value of this variable by default.
  763. :term:`BUILD_CXXFLAGS`
  764. Specifies the flags to pass to the C++ compiler when building for the
  765. build host. When building in the ``-native`` context,
  766. :term:`CXXFLAGS` is set to the value of this variable
  767. by default.
  768. :term:`BUILD_FC`
  769. Specifies the Fortran compiler command for the build host. By
  770. default, :term:`BUILD_FC` points to Gfortran and passes as arguments the
  771. value of :term:`BUILD_CC_ARCH`, assuming
  772. :term:`BUILD_CC_ARCH` is set.
  773. :term:`BUILD_LD`
  774. Specifies the linker command for the build host. By default,
  775. :term:`BUILD_LD` points to the GNU linker (ld) and passes as arguments
  776. the value of :term:`BUILD_LD_ARCH`, assuming
  777. :term:`BUILD_LD_ARCH` is set.
  778. :term:`BUILD_LD_ARCH`
  779. Specifies architecture-specific linker flags for the build host. By
  780. default, the value of :term:`BUILD_LD_ARCH` is empty.
  781. :term:`BUILD_LDFLAGS`
  782. Specifies the flags to pass to the linker when building for the build
  783. host. When building in the ``-native`` context,
  784. :term:`LDFLAGS` is set to the value of this variable
  785. by default.
  786. :term:`BUILD_OPTIMIZATION`
  787. Specifies the optimization flags passed to the C compiler when
  788. building for the build host or the SDK. The flags are passed through
  789. the :term:`BUILD_CFLAGS` and
  790. :term:`BUILDSDK_CFLAGS` default values.
  791. The default value of the :term:`BUILD_OPTIMIZATION` variable is "-O2
  792. -pipe".
  793. :term:`BUILD_OS`
  794. Specifies the operating system in use on the build host (e.g.
  795. "linux"). The OpenEmbedded build system sets the value of
  796. :term:`BUILD_OS` from the OS reported by the ``uname`` command --- the
  797. first word, converted to lower-case characters.
  798. :term:`BUILD_PREFIX`
  799. The toolchain binary prefix used for native recipes. The OpenEmbedded
  800. build system uses the :term:`BUILD_PREFIX` value to set the
  801. :term:`TARGET_PREFIX` when building for :ref:`ref-classes-native` recipes.
  802. :term:`BUILD_STRIP`
  803. Specifies the command to be used to strip debugging symbols from
  804. binaries produced for the build host. By default, :term:`BUILD_STRIP`
  805. points to
  806. ``${``\ :term:`BUILD_PREFIX`\ ``}strip``.
  807. :term:`BUILD_SYS`
  808. Specifies the system, including the architecture and the operating
  809. system, to use when building for the build host (i.e. when building
  810. :ref:`ref-classes-native` recipes).
  811. The OpenEmbedded build system automatically sets this variable based
  812. on :term:`BUILD_ARCH`,
  813. :term:`BUILD_VENDOR`, and
  814. :term:`BUILD_OS`. You do not need to set the
  815. :term:`BUILD_SYS` variable yourself.
  816. :term:`BUILD_VENDOR`
  817. Specifies the vendor name to use when building for the build host.
  818. The default value is an empty string ("").
  819. :term:`BUILDDIR`
  820. Points to the location of the :term:`Build Directory`. You can define
  821. this directory indirectly through the :ref:`structure-core-script` script
  822. by passing in a :term:`Build Directory` path when you run the script. If
  823. you run the script and do not provide a :term:`Build Directory` path, the
  824. :term:`BUILDDIR` defaults to ``build`` in the current directory.
  825. :term:`BUILDHISTORY_COMMIT`
  826. When inheriting the :ref:`ref-classes-buildhistory` class, this variable
  827. specifies whether or not to commit the build history output in a local
  828. Git repository. If set to "1", this local repository will be maintained
  829. automatically by the :ref:`ref-classes-buildhistory` class and a commit
  830. will be created on every build for changes to each top-level subdirectory
  831. of the build history output (images, packages, and sdk). If you want to
  832. track changes to build history over time, you should set this value to
  833. "1".
  834. By default, the :ref:`ref-classes-buildhistory` class
  835. enables committing the buildhistory output in a local Git repository::
  836. BUILDHISTORY_COMMIT ?= "1"
  837. :term:`BUILDHISTORY_COMMIT_AUTHOR`
  838. When inheriting the :ref:`ref-classes-buildhistory`
  839. class, this variable specifies the author to use for each Git commit.
  840. In order for the :term:`BUILDHISTORY_COMMIT_AUTHOR` variable to work, the
  841. :term:`BUILDHISTORY_COMMIT` variable must
  842. be set to "1".
  843. Git requires that the value you provide for the
  844. :term:`BUILDHISTORY_COMMIT_AUTHOR` variable takes the form of "name
  845. email@host". Providing an email address or host that is not valid
  846. does not produce an error.
  847. By default, the :ref:`ref-classes-buildhistory` class sets the variable
  848. as follows::
  849. BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>"
  850. :term:`BUILDHISTORY_DIR`
  851. When inheriting the :ref:`ref-classes-buildhistory`
  852. class, this variable specifies the directory in which build history
  853. information is kept. For more information on how the variable works,
  854. see the :ref:`ref-classes-buildhistory` class.
  855. By default, the :ref:`ref-classes-buildhistory` class sets the directory
  856. as follows::
  857. BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
  858. :term:`BUILDHISTORY_FEATURES`
  859. When inheriting the :ref:`ref-classes-buildhistory`
  860. class, this variable specifies the build history features to be
  861. enabled. For more information on how build history works, see the
  862. ":ref:`dev-manual/build-quality:maintaining build output quality`"
  863. section in the Yocto Project Development Tasks Manual.
  864. You can specify these features in the form of a space-separated list:
  865. - *image:* Analysis of the contents of images, which includes the
  866. list of installed packages among other things.
  867. - *package:* Analysis of the contents of individual packages.
  868. - *sdk:* Analysis of the contents of the software development kit
  869. (SDK).
  870. - *task:* Save output file signatures for
  871. :ref:`shared state <overview-manual/concepts:shared state cache>`
  872. (sstate) tasks.
  873. This saves one file per task and lists the SHA-256 checksums for
  874. each file staged (i.e. the output of the task).
  875. By default, the :ref:`ref-classes-buildhistory` class enables the
  876. following features::
  877. BUILDHISTORY_FEATURES ?= "image package sdk"
  878. :term:`BUILDHISTORY_IMAGE_FILES`
  879. When inheriting the :ref:`ref-classes-buildhistory`
  880. class, this variable specifies a list of paths to files copied from
  881. the image contents into the build history directory under an
  882. "image-files" directory in the directory for the image, so that you
  883. can track the contents of each file. The default is to copy
  884. ``/etc/passwd`` and ``/etc/group``, which allows you to monitor for
  885. changes in user and group entries. You can modify the list to include
  886. any file. Specifying an invalid path does not produce an error.
  887. Consequently, you can include files that might not always be present.
  888. By default, the :ref:`ref-classes-buildhistory` class provides paths to
  889. the following files::
  890. BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
  891. :term:`BUILDHISTORY_PATH_PREFIX_STRIP`
  892. When inheriting the :ref:`ref-classes-buildhistory`
  893. class, this variable specifies a common path prefix that should be
  894. stripped off the beginning of paths in the task signature list when the
  895. ``task`` feature is active in :term:`BUILDHISTORY_FEATURES`. This can be
  896. useful when build history is populated from multiple sources that may not
  897. all use the same top level directory.
  898. By default, the :ref:`ref-classes-buildhistory` class sets the variable
  899. as follows::
  900. BUILDHISTORY_PATH_PREFIX_STRIP ?= ""
  901. In this case, no prefixes will be stripped.
  902. :term:`BUILDHISTORY_PUSH_REPO`
  903. When inheriting the :ref:`ref-classes-buildhistory` class, this variable
  904. optionally specifies a remote repository to which build history pushes
  905. Git changes. In order for :term:`BUILDHISTORY_PUSH_REPO` to work,
  906. :term:`BUILDHISTORY_COMMIT` must be set to "1".
  907. The repository should correspond to a remote address that specifies a
  908. repository as understood by Git, or alternatively to a remote name
  909. that you have set up manually using ``git remote`` within the local
  910. repository.
  911. By default, the :ref:`ref-classes-buildhistory` class sets the variable
  912. as follows::
  913. BUILDHISTORY_PUSH_REPO ?= ""
  914. :term:`BUILDNAME`
  915. See :term:`bitbake:BUILDNAME` in the BitBake manual.
  916. :term:`BUILDSDK_CFLAGS`
  917. Specifies the flags to pass to the C compiler when building for the
  918. SDK. When building in the ``nativesdk-`` context,
  919. :term:`CFLAGS` is set to the value of this variable by
  920. default.
  921. :term:`BUILDSDK_CPPFLAGS`
  922. Specifies the flags to pass to the C pre-processor (i.e. to both the
  923. C and the C++ compilers) when building for the SDK. When building in
  924. the ``nativesdk-`` context, :term:`CPPFLAGS` is set
  925. to the value of this variable by default.
  926. :term:`BUILDSDK_CXXFLAGS`
  927. Specifies the flags to pass to the C++ compiler when building for the
  928. SDK. When building in the ``nativesdk-`` context,
  929. :term:`CXXFLAGS` is set to the value of this variable
  930. by default.
  931. :term:`BUILDSDK_LDFLAGS`
  932. Specifies the flags to pass to the linker when building for the SDK.
  933. When building in the ``nativesdk-`` context,
  934. :term:`LDFLAGS` is set to the value of this variable
  935. by default.
  936. :term:`BUILDSTATS_BASE`
  937. Points to the location of the directory that holds build statistics
  938. when you use and enable the :ref:`ref-classes-buildstats` class. The
  939. :term:`BUILDSTATS_BASE` directory defaults to
  940. ``${``\ :term:`TMPDIR`\ ``}/buildstats/``.
  941. :term:`BUSYBOX_SPLIT_SUID`
  942. For the BusyBox recipe, specifies whether to split the output
  943. executable file into two parts: one for features that require
  944. ``setuid root``, and one for the remaining features (i.e. those that
  945. do not require ``setuid root``).
  946. The :term:`BUSYBOX_SPLIT_SUID` variable defaults to "1", which results in
  947. splitting the output executable file. Set the variable to "0" to get
  948. a single output executable file.
  949. :term:`BZRDIR`
  950. See :term:`bitbake:BZRDIR` in the BitBake manual.
  951. :term:`CACHE`
  952. Specifies the directory BitBake uses to store a cache of the
  953. :term:`Metadata` so it does not need to be parsed every time
  954. BitBake is started.
  955. :term:`CC`
  956. The minimal command and arguments used to run the C compiler.
  957. :term:`CFLAGS`
  958. Specifies the flags to pass to the C compiler. This variable is
  959. exported to an environment variable and thus made visible to the
  960. software being built during the compilation step.
  961. Default initialization for :term:`CFLAGS` varies depending on what is
  962. being built:
  963. - :term:`TARGET_CFLAGS` when building for the
  964. target
  965. - :term:`BUILD_CFLAGS` when building for the
  966. build host (i.e. ``-native``)
  967. - :term:`BUILDSDK_CFLAGS` when building for
  968. an SDK (i.e. ``nativesdk-``)
  969. :term:`CLASSOVERRIDE`
  970. An internal variable specifying the special class override that
  971. should currently apply (e.g. "class-target", "class-native", and so
  972. forth). The classes that use this variable (e.g.
  973. :ref:`ref-classes-native`, :ref:`ref-classes-nativesdk`, and so forth)
  974. set the variable to appropriate values.
  975. .. note::
  976. :term:`CLASSOVERRIDE` gets its default "class-target" value from the
  977. ``bitbake.conf`` file.
  978. As an example, the following override allows you to install extra
  979. files, but only when building for the target::
  980. do_install:append:class-target() {
  981. install my-extra-file ${D}${sysconfdir}
  982. }
  983. Here is an example where ``FOO`` is set to
  984. "native" when building for the build host, and to "other" when not
  985. building for the build host::
  986. FOO:class-native = "native"
  987. FOO = "other"
  988. The underlying mechanism behind :term:`CLASSOVERRIDE` is simply
  989. that it is included in the default value of
  990. :term:`OVERRIDES`.
  991. :term:`CLEANBROKEN`
  992. If set to "1" within a recipe, :term:`CLEANBROKEN` specifies that the
  993. ``make clean`` command does not work for the software being built.
  994. Consequently, the OpenEmbedded build system will not try to run
  995. ``make clean`` during the :ref:`ref-tasks-configure`
  996. task, which is the default behavior.
  997. :term:`COMBINED_FEATURES`
  998. Provides a list of hardware features that are enabled in both
  999. :term:`MACHINE_FEATURES` and
  1000. :term:`DISTRO_FEATURES`. This select list of
  1001. features contains features that make sense to be controlled both at
  1002. the machine and distribution configuration level. For example, the
  1003. "bluetooth" feature requires hardware support but should also be
  1004. optional at the distribution level, in case the hardware supports
  1005. Bluetooth but you do not ever intend to use it.
  1006. :term:`COMMERCIAL_AUDIO_PLUGINS`
  1007. This variable is specific to the :yocto_git:`GStreamer recipes
  1008. </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`.
  1009. It allows to build the GStreamer `"ugly"
  1010. <https://github.com/GStreamer/gst-plugins-ugly>`__ and
  1011. `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ audio plugins.
  1012. See the :ref:`dev-manual/licenses:other variables related to commercial licenses`
  1013. section for usage details.
  1014. :term:`COMMERCIAL_VIDEO_PLUGINS`
  1015. This variable is specific to the :yocto_git:`GStreamer recipes
  1016. </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`.
  1017. It allows to build the GStreamer `"ugly"
  1018. <https://github.com/GStreamer/gst-plugins-ugly>`__ and
  1019. `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ video plugins.
  1020. See the :ref:`dev-manual/licenses:other variables related to commercial licenses`
  1021. section for usage details.
  1022. :term:`COMMON_LICENSE_DIR`
  1023. Points to ``meta/files/common-licenses`` in the
  1024. :term:`Source Directory`, which is where generic license
  1025. files reside.
  1026. :term:`COMPATIBLE_HOST`
  1027. A regular expression that resolves to one or more hosts (when the
  1028. recipe is native) or one or more targets (when the recipe is
  1029. non-native) with which a recipe is compatible. The regular expression
  1030. is matched against :term:`HOST_SYS`. You can use the
  1031. variable to stop recipes from being built for classes of systems with
  1032. which the recipes are not compatible. Stopping these builds is
  1033. particularly useful with kernels. The variable also helps to increase
  1034. parsing speed since the build system skips parsing recipes not
  1035. compatible with the current system.
  1036. :term:`COMPATIBLE_MACHINE`
  1037. A regular expression that resolves to one or more target machines
  1038. with which a recipe is compatible. The regular expression is matched
  1039. against :term:`MACHINEOVERRIDES`. You can use
  1040. the variable to stop recipes from being built for machines with which
  1041. the recipes are not compatible. Stopping these builds is particularly
  1042. useful with kernels. The variable also helps to increase parsing
  1043. speed since the build system skips parsing recipes not compatible
  1044. with the current machine.
  1045. If one wants to have a recipe only available for some architectures
  1046. (here ``aarch64`` and ``mips64``), the following can be used::
  1047. COMPATIBLE_MACHINE = "^$"
  1048. COMPATIBLE_MACHINE:arch64 = "^(aarch64)$"
  1049. COMPATIBLE_MACHINE:mips64 = "^(mips64)$"
  1050. The first line means "match all machines whose :term:`MACHINEOVERRIDES`
  1051. contains the empty string", which will always be none.
  1052. The second is for matching all machines whose :term:`MACHINEOVERRIDES`
  1053. contains one override which is exactly ``aarch64``.
  1054. The third is for matching all machines whose :term:`MACHINEOVERRIDES`
  1055. contains one override which is exactly ``mips64``.
  1056. The same could be achieved with::
  1057. COMPATIBLE_MACHINE = "^(aarch64|mips64)$"
  1058. .. note::
  1059. When :term:`COMPATIBLE_MACHINE` is set in a recipe inherits from
  1060. native, the recipe is always skipped. All native recipes must be
  1061. entirely target independent and should not rely on :term:`MACHINE`.
  1062. :term:`COMPLEMENTARY_GLOB`
  1063. Defines wildcards to match when installing a list of complementary
  1064. packages for all the packages explicitly (or implicitly) installed in
  1065. an image.
  1066. The :term:`COMPLEMENTARY_GLOB` variable uses Unix filename pattern matching
  1067. (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__),
  1068. which is similar to the Unix style pathname pattern expansion
  1069. (`glob <https://docs.python.org/3/library/glob.html>`__).
  1070. The resulting list of complementary packages is associated with an
  1071. item that can be added to
  1072. :term:`IMAGE_FEATURES`. An example usage of
  1073. this is the "dev-pkgs" item that when added to :term:`IMAGE_FEATURES`
  1074. will install -dev packages (containing headers and other development
  1075. files) for every package in the image.
  1076. To add a new feature item pointing to a wildcard, use a variable flag
  1077. to specify the feature item name and use the value to specify the
  1078. wildcard. Here is an example::
  1079. COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
  1080. .. note::
  1081. When installing complementary packages, recommends relationships
  1082. (set via :term:`RRECOMMENDS`) are always ignored.
  1083. :term:`COMPONENTS_DIR`
  1084. Stores sysroot components for each recipe. The OpenEmbedded build
  1085. system uses :term:`COMPONENTS_DIR` when constructing recipe-specific
  1086. sysroots for other recipes.
  1087. The default is
  1088. "``${``\ :term:`STAGING_DIR`\ ``}-components``."
  1089. (i.e.
  1090. "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``").
  1091. :term:`CONF_VERSION`
  1092. Tracks the version of the local configuration file (i.e.
  1093. ``local.conf``). The value for :term:`CONF_VERSION` increments each time
  1094. ``build/conf/`` compatibility changes.
  1095. :term:`CONFFILES`
  1096. Identifies editable or configurable files that are part of a package.
  1097. If the Package Management System (PMS) is being used to update
  1098. packages on the target system, it is possible that configuration
  1099. files you have changed after the original installation and that you
  1100. now want to remain unchanged are overwritten. In other words,
  1101. editable files might exist in the package that you do not want reset
  1102. as part of the package update process. You can use the :term:`CONFFILES`
  1103. variable to list the files in the package that you wish to prevent
  1104. the PMS from overwriting during this update process.
  1105. To use the :term:`CONFFILES` variable, provide a package name override
  1106. that identifies the resulting package. Then, provide a
  1107. space-separated list of files. Here is an example::
  1108. CONFFILES:${PN} += "${sysconfdir}/file1 \
  1109. ${sysconfdir}/file2 ${sysconfdir}/file3"
  1110. There is a relationship between the :term:`CONFFILES` and :term:`FILES`
  1111. variables. The files listed within :term:`CONFFILES` must be a subset of
  1112. the files listed within :term:`FILES`. Because the configuration files
  1113. you provide with :term:`CONFFILES` are simply being identified so that
  1114. the PMS will not overwrite them, it makes sense that the files must
  1115. already be included as part of the package through the :term:`FILES`
  1116. variable.
  1117. .. note::
  1118. When specifying paths as part of the :term:`CONFFILES` variable, it is
  1119. good practice to use appropriate path variables.
  1120. For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}``
  1121. rather than ``/usr/bin``. You can find a list of these variables at
  1122. the top of the ``meta/conf/bitbake.conf`` file in the
  1123. :term:`Source Directory`.
  1124. :term:`CONFIG_INITRAMFS_SOURCE`
  1125. Identifies the initial RAM filesystem (:term:`Initramfs`) source files. The
  1126. OpenEmbedded build system receives and uses this kernel Kconfig
  1127. variable as an environment variable. By default, the variable is set
  1128. to null ("").
  1129. The :term:`CONFIG_INITRAMFS_SOURCE` can be either a single cpio archive
  1130. with a ``.cpio`` suffix or a space-separated list of directories and
  1131. files for building the :term:`Initramfs` image. A cpio archive should contain
  1132. a filesystem archive to be used as an :term:`Initramfs` image. Directories
  1133. should contain a filesystem layout to be included in the :term:`Initramfs`
  1134. image. Files should contain entries according to the format described
  1135. by the ``usr/gen_init_cpio`` program in the kernel tree.
  1136. If you specify multiple directories and files, the :term:`Initramfs` image
  1137. will be the aggregate of all of them.
  1138. For information on creating an :term:`Initramfs`, see the
  1139. ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section
  1140. in the Yocto Project Development Tasks Manual.
  1141. :term:`CONFIG_SITE`
  1142. A list of files that contains ``autoconf`` test results relevant to
  1143. the current build. This variable is used by the Autotools utilities
  1144. when running ``configure``.
  1145. :term:`CONFIGURE_FLAGS`
  1146. The minimal arguments for GNU configure.
  1147. :term:`CONFLICT_DISTRO_FEATURES`
  1148. When inheriting the :ref:`ref-classes-features_check`
  1149. class, this variable identifies distribution features that would be
  1150. in conflict should the recipe be built. In other words, if the
  1151. :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also
  1152. appears in :term:`DISTRO_FEATURES` within the current configuration, then
  1153. the recipe will be skipped, and if the build system attempts to build
  1154. the recipe then an error will be triggered.
  1155. :term:`CONVERSION_CMD`
  1156. This variable is used for storing image conversion commands.
  1157. Image conversion can convert an image into different objects like:
  1158. - Compressed version of the image
  1159. - Checksums for the image
  1160. An example of :term:`CONVERSION_CMD` from :ref:`ref-classes-image_types`
  1161. class is::
  1162. CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
  1163. :term:`COPY_LIC_DIRS`
  1164. If set to "1" along with the
  1165. :term:`COPY_LIC_MANIFEST` variable, the
  1166. OpenEmbedded build system copies into the image the license files,
  1167. which are located in ``/usr/share/common-licenses``, for each
  1168. package. The license files are placed in directories within the image
  1169. itself during build time.
  1170. .. note::
  1171. The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for
  1172. newly installed packages to an image, which might be most suitable for
  1173. read-only filesystems that cannot be upgraded. See the
  1174. :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
  1175. You can also reference the ":ref:`dev-manual/licenses:providing license text`"
  1176. section in the Yocto Project Development Tasks Manual for
  1177. information on providing license text.
  1178. :term:`COPY_LIC_MANIFEST`
  1179. If set to "1", the OpenEmbedded build system copies the license
  1180. manifest for the image to
  1181. ``/usr/share/common-licenses/license.manifest`` within the image
  1182. itself during build time.
  1183. .. note::
  1184. The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for
  1185. newly installed packages to an image, which might be most suitable for
  1186. read-only filesystems that cannot be upgraded. See the
  1187. :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
  1188. You can also reference the ":ref:`dev-manual/licenses:providing license text`"
  1189. section in the Yocto Project Development Tasks Manual for
  1190. information on providing license text.
  1191. :term:`COPYLEFT_LICENSE_EXCLUDE`
  1192. A space-separated list of licenses to exclude from the source archived by
  1193. the :ref:`ref-classes-archiver` class. In other words, if a license in a
  1194. recipe's :term:`LICENSE` value is in the value of
  1195. :term:`COPYLEFT_LICENSE_EXCLUDE`, then its source is not archived by the
  1196. class.
  1197. .. note::
  1198. The :term:`COPYLEFT_LICENSE_EXCLUDE` variable takes precedence over the
  1199. :term:`COPYLEFT_LICENSE_INCLUDE` variable.
  1200. The default value, which is "CLOSED Proprietary", for
  1201. :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the
  1202. :ref:`ref-classes-copyleft_filter` class, which
  1203. is inherited by the :ref:`ref-classes-archiver` class.
  1204. :term:`COPYLEFT_LICENSE_INCLUDE`
  1205. A space-separated list of licenses to include in the source archived
  1206. by the :ref:`ref-classes-archiver` class. In other
  1207. words, if a license in a recipe's :term:`LICENSE`
  1208. value is in the value of :term:`COPYLEFT_LICENSE_INCLUDE`, then its
  1209. source is archived by the class.
  1210. The default value is set by the :ref:`ref-classes-copyleft_filter` class,
  1211. which is inherited by the :ref:`ref-classes-archiver` class. The default
  1212. value includes "GPL*", "LGPL*", and "AGPL*".
  1213. :term:`COPYLEFT_PN_EXCLUDE`
  1214. A list of recipes to exclude in the source archived by the
  1215. :ref:`ref-classes-archiver` class. The :term:`COPYLEFT_PN_EXCLUDE`
  1216. variable overrides the license inclusion and exclusion caused through the
  1217. :term:`COPYLEFT_LICENSE_INCLUDE` and :term:`COPYLEFT_LICENSE_EXCLUDE`
  1218. variables, respectively.
  1219. The default value, which is "" indicating to not explicitly exclude
  1220. any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the
  1221. :ref:`ref-classes-copyleft_filter` class, which is inherited by the
  1222. :ref:`ref-classes-archiver` class.
  1223. :term:`COPYLEFT_PN_INCLUDE`
  1224. A list of recipes to include in the source archived by the
  1225. :ref:`ref-classes-archiver` class. The :term:`COPYLEFT_PN_INCLUDE`
  1226. variable overrides the license inclusion and exclusion caused through the
  1227. :term:`COPYLEFT_LICENSE_INCLUDE` and :term:`COPYLEFT_LICENSE_EXCLUDE`
  1228. variables, respectively.
  1229. The default value, which is "" indicating to not explicitly include
  1230. any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the
  1231. :ref:`ref-classes-copyleft_filter` class, which is inherited by the
  1232. :ref:`ref-classes-archiver` class.
  1233. :term:`COPYLEFT_RECIPE_TYPES`
  1234. A space-separated list of recipe types to include in the source
  1235. archived by the :ref:`archiver <ref-classes-archiver>` class.
  1236. Recipe types are ``target``, :ref:`ref-classes-native`,
  1237. :ref:`ref-classes-nativesdk`, :ref:`ref-classes-cross`,
  1238. :ref:`ref-classes-crosssdk`, and :ref:`ref-classes-cross-canadian`.
  1239. The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES`
  1240. is set by the :ref:`ref-classes-copyleft_filter` class, which is
  1241. inherited by the :ref:`ref-classes-archiver` class.
  1242. :term:`CORE_IMAGE_EXTRA_INSTALL`
  1243. Specifies the list of packages to be added to the image. You should
  1244. only set this variable in the ``local.conf`` configuration file found
  1245. in the :term:`Build Directory`.
  1246. This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer
  1247. supported.
  1248. :term:`COREBASE`
  1249. Specifies the parent directory of the OpenEmbedded-Core Metadata
  1250. layer (i.e. ``meta``).
  1251. It is an important distinction that :term:`COREBASE` points to the parent
  1252. of this layer and not the layer itself. Consider an example where you
  1253. have cloned the Poky Git repository and retained the ``poky`` name
  1254. for your local copy of the repository. In this case, :term:`COREBASE`
  1255. points to the ``poky`` folder because it is the parent directory of
  1256. the ``poky/meta`` layer.
  1257. :term:`COREBASE_FILES`
  1258. Lists files from the :term:`COREBASE` directory that
  1259. should be copied other than the layers listed in the
  1260. ``bblayers.conf`` file. The :term:`COREBASE_FILES` variable allows
  1261. to copy metadata from the OpenEmbedded build system
  1262. into the extensible SDK.
  1263. Explicitly listing files in :term:`COREBASE` is needed because it
  1264. typically contains build directories and other files that should not
  1265. normally be copied into the extensible SDK. Consequently, the value
  1266. of :term:`COREBASE_FILES` is used in order to only copy the files that
  1267. are actually needed.
  1268. :term:`CPP`
  1269. The minimal command and arguments used to run the C preprocessor.
  1270. :term:`CPPFLAGS`
  1271. Specifies the flags to pass to the C pre-processor (i.e. to both the
  1272. C and the C++ compilers). This variable is exported to an environment
  1273. variable and thus made visible to the software being built during the
  1274. compilation step.
  1275. Default initialization for :term:`CPPFLAGS` varies depending on what is
  1276. being built:
  1277. - :term:`TARGET_CPPFLAGS` when building for
  1278. the target
  1279. - :term:`BUILD_CPPFLAGS` when building for the
  1280. build host (i.e. ``-native``)
  1281. - :term:`BUILDSDK_CPPFLAGS` when building
  1282. for an SDK (i.e. ``nativesdk-``)
  1283. :term:`CROSS_COMPILE`
  1284. The toolchain binary prefix for the target tools. The
  1285. :term:`CROSS_COMPILE` variable is the same as the
  1286. :term:`TARGET_PREFIX` variable.
  1287. .. note::
  1288. The OpenEmbedded build system sets the :term:`CROSS_COMPILE`
  1289. variable only in certain contexts (e.g. when building for kernel
  1290. and kernel module recipes).
  1291. :term:`CVE_CHECK_IGNORE`
  1292. This variable is deprecated and should be replaced by :term:`CVE_STATUS`.
  1293. :term:`CVE_CHECK_SHOW_WARNINGS`
  1294. Specifies whether or not the :ref:`ref-classes-cve-check`
  1295. class should generate warning messages on the console when unpatched
  1296. CVEs are found. The default is "1", but you may wish to set it to "0" if
  1297. you are already examining/processing the logs after the build has
  1298. completed and thus do not need the warning messages.
  1299. :term:`CVE_CHECK_SKIP_RECIPE`
  1300. The list of package names (:term:`PN`) for which
  1301. CVEs (Common Vulnerabilities and Exposures) are ignored.
  1302. :term:`CVE_DB_UPDATE_INTERVAL`
  1303. Specifies the CVE database update interval in seconds, as used by
  1304. ``cve-update-db-native``. The default value is "86400" i.e. once a day
  1305. (24*60*60). If the value is set to "0" then the update will be forced
  1306. every time. Alternatively, a negative value e.g. "-1" will disable
  1307. updates entirely.
  1308. :term:`CVE_PRODUCT`
  1309. In a recipe, defines the name used to match the recipe name
  1310. against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__.
  1311. The default is ${:term:`BPN`} (except for recipes that inherit the
  1312. :ref:`ref-classes-pypi` class where it is set based upon
  1313. :term:`PYPI_PACKAGE`). If it does not match the name in the NIST CVE
  1314. database or matches with multiple entries in the database, the default
  1315. value needs to be changed.
  1316. Here is an example from the :oe_layerindex:`Berkeley DB recipe </layerindex/recipe/544>`::
  1317. CVE_PRODUCT = "oracle_berkeley_db berkeley_db"
  1318. Sometimes the product name is not specific enough, for example
  1319. "tar" has been matching CVEs for the GNU ``tar`` package and also
  1320. the ``node-tar`` node.js extension. To avoid this problem, use the
  1321. vendor name as a prefix. The syntax for this is::
  1322. CVE_PRODUCT = "vendor:package"
  1323. :term:`CVE_STATUS`
  1324. The CVE ID which is patched or should be ignored. Here is
  1325. an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`::
  1326. CVE_STATUS[CVE-2020-15523] = "not-applicable-platform: Issue only applies on Windows"
  1327. It has the format "reason: description" and the description is optional.
  1328. The Reason is mapped to the final CVE state by mapping via
  1329. :term:`CVE_CHECK_STATUSMAP`. See :ref:`dev-manual/vulnerabilities:fixing vulnerabilities in recipes`
  1330. for details.
  1331. :term:`CVE_STATUS_GROUPS`
  1332. If there are many CVEs with the same status and reason, they can by simplified by using this
  1333. variable instead of many similar lines with :term:`CVE_STATUS`::
  1334. CVE_STATUS_GROUPS = "CVE_STATUS_WIN CVE_STATUS_PATCHED"
  1335. CVE_STATUS_WIN = "CVE-1234-0001 CVE-1234-0002"
  1336. CVE_STATUS_WIN[status] = "not-applicable-platform: Issue only applies on Windows"
  1337. CVE_STATUS_PATCHED = "CVE-1234-0003 CVE-1234-0004"
  1338. CVE_STATUS_PATCHED[status] = "fixed-version: Fixed externally"
  1339. :term:`CVE_CHECK_STATUSMAP`
  1340. Mapping variable for all possible reasons of :term:`CVE_STATUS`:
  1341. ``Patched``, ``Unpatched`` and ``Ignored``.
  1342. See :ref:`ref-classes-cve-check` or ``meta/conf/cve-check-map.conf`` for more details::
  1343. CVE_CHECK_STATUSMAP[cpe-incorrect] = "Ignored"
  1344. :term:`CVE_VERSION`
  1345. In a recipe, defines the version used to match the recipe version
  1346. against the version in the `NIST CVE database <https://nvd.nist.gov/>`__
  1347. when usign :ref:`ref-classes-cve-check`.
  1348. The default is ${:term:`PV`} but if recipes use custom version numbers
  1349. which do not map to upstream software component release versions and the versions
  1350. used in the CVE database, then this variable can be used to set the
  1351. version number for :ref:`ref-classes-cve-check`. Example::
  1352. CVE_VERSION = "2.39"
  1353. :term:`CVSDIR`
  1354. The directory in which files checked out under the CVS system are
  1355. stored.
  1356. :term:`CXX`
  1357. The minimal command and arguments used to run the C++ compiler.
  1358. :term:`CXXFLAGS`
  1359. Specifies the flags to pass to the C++ compiler. This variable is
  1360. exported to an environment variable and thus made visible to the
  1361. software being built during the compilation step.
  1362. Default initialization for :term:`CXXFLAGS` varies depending on what is
  1363. being built:
  1364. - :term:`TARGET_CXXFLAGS` when building for
  1365. the target
  1366. - :term:`BUILD_CXXFLAGS` when building for the
  1367. build host (i.e. ``-native``)
  1368. - :term:`BUILDSDK_CXXFLAGS` when building
  1369. for an SDK (i.e. ``nativesdk-``)
  1370. :term:`D`
  1371. The destination directory. The location in the :term:`Build Directory`
  1372. where components are installed by the
  1373. :ref:`ref-tasks-install` task. This location defaults
  1374. to::
  1375. ${WORKDIR}/image
  1376. .. note::
  1377. Tasks that read from or write to this directory should run under
  1378. :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
  1379. :term:`DATE`
  1380. The date the build was started. Dates appear using the year, month,
  1381. and day (YMD) format (e.g. "20150209" for February 9th, 2015).
  1382. :term:`DATETIME`
  1383. The date and time on which the current build started. The format is
  1384. suitable for timestamps.
  1385. :term:`DEBIAN_NOAUTONAME`
  1386. When the :ref:`ref-classes-debian` class is inherited,
  1387. which is the default behavior, :term:`DEBIAN_NOAUTONAME` specifies a
  1388. particular package should not be renamed according to Debian library
  1389. package naming. You must use the package name as an override when you
  1390. set this variable. Here is an example from the ``fontconfig`` recipe::
  1391. DEBIAN_NOAUTONAME:fontconfig-utils = "1"
  1392. :term:`DEBIANNAME`
  1393. When the :ref:`ref-classes-debian` class is inherited,
  1394. which is the default behavior, :term:`DEBIANNAME` allows you to override
  1395. the library name for an individual package. Overriding the library
  1396. name in these cases is rare. You must use the package name as an
  1397. override when you set this variable. Here is an example from the
  1398. ``dbus`` recipe::
  1399. DEBIANNAME:${PN} = "dbus-1"
  1400. :term:`DEBUG_BUILD`
  1401. Specifies to build packages with debugging information. This
  1402. influences the value of the :term:`SELECTED_OPTIMIZATION` variable.
  1403. :term:`DEBUG_OPTIMIZATION`
  1404. The options to pass in :term:`TARGET_CFLAGS` and :term:`CFLAGS` when
  1405. compiling a system for debugging. This variable defaults to "-O
  1406. -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
  1407. :term:`DEBUG_PREFIX_MAP`
  1408. Allows to set C compiler options, such as ``-fdebug-prefix-map``,
  1409. ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to
  1410. replace build-time paths by install-time ones in the debugging sections
  1411. of binaries. This makes compiler output files location independent,
  1412. at the cost of having to pass an extra command to tell the debugger
  1413. where source files are.
  1414. This is used by the Yocto Project to guarantee
  1415. :doc:`/test-manual/reproducible-builds` even when the source code of
  1416. a package uses the ``__FILE__`` or ``assert()`` macros. See the
  1417. `reproducible-builds.org <https://reproducible-builds.org/docs/build-path/>`__
  1418. website for details.
  1419. This variable is set in the ``meta/conf/bitbake.conf`` file. It is
  1420. not intended to be user-configurable.
  1421. :term:`DEFAULT_PREFERENCE`
  1422. Specifies a weak bias for recipe selection priority.
  1423. The most common usage of this is variable is to set it to "-1" within
  1424. a recipe for a development version of a piece of software. Using the
  1425. variable in this way causes the stable version of the recipe to build
  1426. by default in the absence of :term:`PREFERRED_VERSION` being used to
  1427. build the development version.
  1428. .. note::
  1429. The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden
  1430. by :term:`BBFILE_PRIORITY` if that variable is different between two
  1431. layers that contain different versions of the same recipe.
  1432. :term:`DEFAULTTUNE`
  1433. The default CPU and Application Binary Interface (ABI) tunings (i.e.
  1434. the "tune") used by the OpenEmbedded build system. The
  1435. :term:`DEFAULTTUNE` helps define
  1436. :term:`TUNE_FEATURES`.
  1437. The default tune is either implicitly or explicitly set by the
  1438. machine (:term:`MACHINE`). However, you can override
  1439. the setting using available tunes as defined with
  1440. :term:`AVAILTUNES`.
  1441. :term:`DEPENDS`
  1442. Lists a recipe's build-time dependencies. These are dependencies on
  1443. other recipes whose contents (e.g. headers and shared libraries) are
  1444. needed by the recipe at build time.
  1445. As an example, consider a recipe ``foo`` that contains the following
  1446. assignment::
  1447. DEPENDS = "bar"
  1448. The practical effect of the previous assignment is that all files
  1449. installed by bar will be available in the appropriate staging sysroot,
  1450. given by the :term:`STAGING_DIR* <STAGING_DIR>` variables, by the time
  1451. the :ref:`ref-tasks-configure` task for ``foo`` runs. This mechanism is
  1452. implemented by having :ref:`ref-tasks-configure` depend on the
  1453. :ref:`ref-tasks-populate_sysroot` task of each recipe listed in
  1454. :term:`DEPENDS`, through a
  1455. ``[``\ :ref:`deptask <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
  1456. declaration in the :ref:`ref-classes-base` class.
  1457. .. note::
  1458. It seldom is necessary to reference, for example, :term:`STAGING_DIR_HOST`
  1459. explicitly. The standard classes and build-related variables are
  1460. configured to automatically use the appropriate staging sysroots.
  1461. As another example, :term:`DEPENDS` can also be used to add utilities
  1462. that run on the build machine during the build. For example, a recipe
  1463. that makes use of a code generator built by the recipe ``codegen``
  1464. might have the following::
  1465. DEPENDS = "codegen-native"
  1466. For more
  1467. information, see the :ref:`ref-classes-native` class and
  1468. the :term:`EXTRANATIVEPATH` variable.
  1469. .. note::
  1470. - :term:`DEPENDS` is a list of recipe names. Or, to be more precise,
  1471. it is a list of :term:`PROVIDES` names, which
  1472. usually match recipe names. Putting a package name such as
  1473. "foo-dev" in :term:`DEPENDS` does not make sense. Use "foo"
  1474. instead, as this will put files from all the packages that make
  1475. up ``foo``, which includes those from ``foo-dev``, into the
  1476. sysroot.
  1477. - One recipe having another recipe in :term:`DEPENDS` does not by
  1478. itself add any runtime dependencies between the packages
  1479. produced by the two recipes. However, as explained in the
  1480. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  1481. section in the Yocto Project Overview and Concepts Manual,
  1482. runtime dependencies will often be added automatically, meaning
  1483. :term:`DEPENDS` alone is sufficient for most recipes.
  1484. - Counterintuitively, :term:`DEPENDS` is often necessary even for
  1485. recipes that install precompiled components. For example, if
  1486. ``libfoo`` is a precompiled library that links against
  1487. ``libbar``, then linking against ``libfoo`` requires both
  1488. ``libfoo`` and ``libbar`` to be available in the sysroot.
  1489. Without a :term:`DEPENDS` from the recipe that installs ``libfoo``
  1490. to the recipe that installs ``libbar``, other recipes might
  1491. fail to link against ``libfoo``.
  1492. For information on runtime dependencies, see the :term:`RDEPENDS`
  1493. variable. You can also see the
  1494. ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and
  1495. ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`"
  1496. sections in the BitBake User Manual for additional information on tasks
  1497. and dependencies.
  1498. :term:`DEPLOY_DIR`
  1499. Points to the general area that the OpenEmbedded build system uses to
  1500. place images, packages, SDKs, and other output files that are ready
  1501. to be used outside of the build system. By default, this directory
  1502. resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``.
  1503. For more information on the structure of the Build Directory, see
  1504. ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
  1505. For more detail on the contents of the ``deploy`` directory, see the
  1506. ":ref:`overview-manual/concepts:images`",
  1507. ":ref:`overview-manual/concepts:package feeds`", and
  1508. ":ref:`overview-manual/concepts:application development sdk`" sections all in the
  1509. Yocto Project Overview and Concepts Manual.
  1510. :term:`DEPLOY_DIR_DEB`
  1511. Points to the area that the OpenEmbedded build system uses to place
  1512. Debian packages that are ready to be used outside of the build
  1513. system. This variable applies only when :term:`PACKAGE_CLASSES` contains
  1514. ":ref:`ref-classes-package_deb`".
  1515. The BitBake configuration file initially defines the
  1516. :term:`DEPLOY_DIR_DEB` variable as a sub-folder of
  1517. :term:`DEPLOY_DIR`::
  1518. DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
  1519. The :ref:`ref-classes-package_deb` class uses the
  1520. :term:`DEPLOY_DIR_DEB` variable to make sure the
  1521. :ref:`ref-tasks-package_write_deb` task
  1522. writes Debian packages into the appropriate folder. For more
  1523. information on how packaging works, see the
  1524. ":ref:`overview-manual/concepts:package feeds`" section
  1525. in the Yocto Project Overview and Concepts Manual.
  1526. :term:`DEPLOY_DIR_IMAGE`
  1527. Points to the area that the OpenEmbedded build system uses to place
  1528. images and other associated output files that are ready to be
  1529. deployed onto the target machine. The directory is machine-specific
  1530. as it contains the ``${MACHINE}`` name. By default, this directory
  1531. resides within the :term:`Build Directory` as
  1532. ``${DEPLOY_DIR}/images/${MACHINE}/``.
  1533. It must not be used directly in recipes when deploying files. Instead,
  1534. it's only useful when a recipe needs to "read" a file already deployed
  1535. by a dependency. So, it should be filled with the contents of
  1536. :term:`DEPLOYDIR` by the :ref:`ref-classes-deploy` class or with the
  1537. contents of :term:`IMGDEPLOYDIR` by the :ref:`ref-classes-image` class.
  1538. For more information on the structure of the :term:`Build Directory`, see
  1539. ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section.
  1540. For more detail on the contents of the ``deploy`` directory, see the
  1541. ":ref:`overview-manual/concepts:images`" and
  1542. ":ref:`overview-manual/concepts:application development sdk`" sections both in
  1543. the Yocto Project Overview and Concepts Manual.
  1544. :term:`DEPLOY_DIR_IPK`
  1545. Points to the area that the OpenEmbedded build system uses to place
  1546. IPK packages that are ready to be used outside of the build system.
  1547. This variable applies only when :term:`PACKAGE_CLASSES` contains
  1548. ":ref:`ref-classes-package_ipk`".
  1549. The BitBake configuration file initially defines this variable as a
  1550. sub-folder of :term:`DEPLOY_DIR`::
  1551. DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk"
  1552. The :ref:`ref-classes-package_ipk` class uses the :term:`DEPLOY_DIR_IPK`
  1553. variable to make sure the :ref:`ref-tasks-package_write_ipk` task
  1554. writes IPK packages into the appropriate folder. For more information
  1555. on how packaging works, see the
  1556. ":ref:`overview-manual/concepts:package feeds`" section
  1557. in the Yocto Project Overview and Concepts Manual.
  1558. :term:`DEPLOY_DIR_RPM`
  1559. Points to the area that the OpenEmbedded build system uses to place
  1560. RPM packages that are ready to be used outside of the build system.
  1561. This variable applies only when :term:`PACKAGE_CLASSES` contains
  1562. ":ref:`ref-classes-package_rpm`".
  1563. The BitBake configuration file initially defines this variable as a
  1564. sub-folder of :term:`DEPLOY_DIR`::
  1565. DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm"
  1566. The :ref:`ref-classes-package_rpm` class uses the
  1567. :term:`DEPLOY_DIR_RPM` variable to make sure the
  1568. :ref:`ref-tasks-package_write_rpm` task
  1569. writes RPM packages into the appropriate folder. For more information
  1570. on how packaging works, see the
  1571. ":ref:`overview-manual/concepts:package feeds`" section
  1572. in the Yocto Project Overview and Concepts Manual.
  1573. :term:`DEPLOYDIR`
  1574. When inheriting the :ref:`ref-classes-deploy` class, the
  1575. :term:`DEPLOYDIR` points to a temporary work area for deployed files that
  1576. is set in the :ref:`ref-classes-deploy` class as follows::
  1577. DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
  1578. Recipes inheriting the :ref:`ref-classes-deploy` class should copy files to be
  1579. deployed into :term:`DEPLOYDIR`, and the class will take care of copying
  1580. them into :term:`DEPLOY_DIR_IMAGE`
  1581. afterwards.
  1582. :term:`DESCRIPTION`
  1583. The package description used by package managers. If not set,
  1584. :term:`DESCRIPTION` takes the value of the :term:`SUMMARY`
  1585. variable.
  1586. :term:`DEV_PKG_DEPENDENCY`
  1587. Provides an easy way for recipes to disable or adjust the runtime recommendation
  1588. (:term:`RRECOMMENDS`) of the ``${PN}-dev`` package on the main
  1589. (``${PN}``) package.
  1590. :term:`DISABLE_STATIC`
  1591. Used in order to disable static linking by default (in order to save
  1592. space, since static libraries are often unused in embedded systems.)
  1593. The default value is " --disable-static", however it can be set to ""
  1594. in order to enable static linking if desired. Certain recipes do this
  1595. individually, and also there is a
  1596. ``meta/conf/distro/include/no-static-libs.inc`` include file that
  1597. disables static linking for a number of recipes. Some software
  1598. packages or build tools (such as CMake) have explicit support for
  1599. enabling / disabling static linking, and in those cases
  1600. :term:`DISABLE_STATIC` is not used.
  1601. :term:`DISTRO`
  1602. The short name of the distribution. For information on the long name
  1603. of the distribution, see the :term:`DISTRO_NAME`
  1604. variable.
  1605. The :term:`DISTRO` variable corresponds to a distribution configuration
  1606. file whose root name is the same as the variable's argument and whose
  1607. filename extension is ``.conf``. For example, the distribution
  1608. configuration file for the Poky distribution is named ``poky.conf``
  1609. and resides in the ``meta-poky/conf/distro`` directory of the
  1610. :term:`Source Directory`.
  1611. Within that ``poky.conf`` file, the :term:`DISTRO` variable is set as
  1612. follows::
  1613. DISTRO = "poky"
  1614. Distribution configuration files are located in a ``conf/distro``
  1615. directory within the :term:`Metadata` that contains the
  1616. distribution configuration. The value for :term:`DISTRO` must not contain
  1617. spaces, and is typically all lower-case.
  1618. .. note::
  1619. If the :term:`DISTRO` variable is blank, a set of default configurations
  1620. are used, which are specified within
  1621. ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
  1622. :term:`DISTRO_CODENAME`
  1623. Specifies a codename for the distribution being built.
  1624. :term:`DISTRO_EXTRA_RDEPENDS`
  1625. Specifies a list of distro-specific packages to add to all images.
  1626. This variable takes effect through ``packagegroup-base`` so the
  1627. variable only really applies to the more full-featured images that
  1628. include ``packagegroup-base``. You can use this variable to keep
  1629. distro policy out of generic images. As with all other distro
  1630. variables, you set this variable in the distro ``.conf`` file.
  1631. :term:`DISTRO_EXTRA_RRECOMMENDS`
  1632. Specifies a list of distro-specific packages to add to all images if
  1633. the packages exist. The packages might not exist or be empty (e.g.
  1634. kernel modules). The list of packages are automatically installed but
  1635. you can remove them.
  1636. :term:`DISTRO_FEATURES`
  1637. The software support you want in your distribution for various
  1638. features. You define your distribution features in the distribution
  1639. configuration file.
  1640. In most cases, the presence or absence of a feature in
  1641. :term:`DISTRO_FEATURES` is translated to the appropriate option supplied
  1642. to the configure script during the
  1643. :ref:`ref-tasks-configure` task for recipes that
  1644. optionally support the feature. For example, specifying "x11" in
  1645. :term:`DISTRO_FEATURES`, causes every piece of software built for the
  1646. target that can optionally support X11 to have its X11 support
  1647. enabled.
  1648. .. note::
  1649. Just enabling :term:`DISTRO_FEATURES` alone doesn't
  1650. enable feature support for packages. Mechanisms such as making
  1651. :term:`PACKAGECONFIG` track :term:`DISTRO_FEATURES` are used
  1652. to enable/disable package features.
  1653. Two more examples are Bluetooth and NFS support. For a more complete
  1654. list of features that ships with the Yocto Project and that you can
  1655. provide with this variable, see the ":ref:`ref-features-distro`" section.
  1656. :term:`DISTRO_FEATURES_BACKFILL`
  1657. A space-separated list of features to be added to :term:`DISTRO_FEATURES`
  1658. if not also present in :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`.
  1659. This variable is set in the ``meta/conf/bitbake.conf`` file. It is
  1660. not intended to be user-configurable. It is best to just reference
  1661. the variable to see which distro features are being
  1662. :ref:`backfilled <ref-features-backfill>` for all distro configurations.
  1663. :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
  1664. A space-separated list of features from :term:`DISTRO_FEATURES_BACKFILL`
  1665. that should not be :ref:`backfilled <ref-features-backfill>` (i.e. added
  1666. to :term:`DISTRO_FEATURES`) during the build.
  1667. This corresponds to an opt-out mechanism. When new default distro
  1668. features are introduced, distribution maintainers can review (`consider`)
  1669. them and decide to exclude them from the
  1670. :ref:`backfilled <ref-features-backfill>` features. Therefore, the
  1671. combination of :term:`DISTRO_FEATURES_BACKFILL` and
  1672. :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` makes it possible to
  1673. add new default features without breaking existing distributions.
  1674. :term:`DISTRO_FEATURES_DEFAULT`
  1675. A convenience variable that gives you the default list of distro
  1676. features with the exception of any features specific to the C library
  1677. (``libc``).
  1678. When creating a custom distribution, you might find it useful to be
  1679. able to reuse the default
  1680. :term:`DISTRO_FEATURES` options without the
  1681. need to write out the full set. Here is an example that uses
  1682. :term:`DISTRO_FEATURES_DEFAULT` from a custom distro configuration file::
  1683. DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature"
  1684. :term:`DISTRO_FEATURES_FILTER_NATIVE`
  1685. Specifies a list of features that if present in the target
  1686. :term:`DISTRO_FEATURES` value should be
  1687. included in :term:`DISTRO_FEATURES` when building native recipes. This
  1688. variable is used in addition to the features filtered using the
  1689. :term:`DISTRO_FEATURES_NATIVE`
  1690. variable.
  1691. :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
  1692. Specifies a list of features that if present in the target
  1693. :term:`DISTRO_FEATURES` value should be included in
  1694. :term:`DISTRO_FEATURES` when building :ref:`ref-classes-nativesdk`
  1695. recipes. This variable is used in addition to the features filtered using
  1696. the :term:`DISTRO_FEATURES_NATIVESDK` variable.
  1697. :term:`DISTRO_FEATURES_NATIVE`
  1698. Specifies a list of features that should be included in
  1699. :term:`DISTRO_FEATURES` when building native
  1700. recipes. This variable is used in addition to the features filtered
  1701. using the
  1702. :term:`DISTRO_FEATURES_FILTER_NATIVE`
  1703. variable.
  1704. :term:`DISTRO_FEATURES_NATIVESDK`
  1705. Specifies a list of features that should be included in
  1706. :term:`DISTRO_FEATURES` when building
  1707. :ref:`ref-classes-nativesdk` recipes. This variable is used
  1708. in addition to the features filtered using the
  1709. :term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable.
  1710. :term:`DISTRO_NAME`
  1711. The long name of the distribution. For information on the short name
  1712. of the distribution, see the :term:`DISTRO` variable.
  1713. The :term:`DISTRO_NAME` variable corresponds to a distribution
  1714. configuration file whose root name is the same as the variable's
  1715. argument and whose filename extension is ``.conf``. For example, the
  1716. distribution configuration file for the Poky distribution is named
  1717. ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory
  1718. of the :term:`Source Directory`.
  1719. Within that ``poky.conf`` file, the :term:`DISTRO_NAME` variable is set
  1720. as follows::
  1721. DISTRO_NAME = "Poky (Yocto Project Reference Distro)"
  1722. Distribution configuration files are located in a ``conf/distro``
  1723. directory within the :term:`Metadata` that contains the
  1724. distribution configuration.
  1725. .. note::
  1726. If the :term:`DISTRO_NAME` variable is blank, a set of default
  1727. configurations are used, which are specified within
  1728. ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
  1729. :term:`DISTRO_VERSION`
  1730. The version of the distribution.
  1731. :term:`DISTROOVERRIDES`
  1732. A colon-separated list of overrides specific to the current
  1733. distribution. By default, this list includes the value of
  1734. :term:`DISTRO`.
  1735. You can extend :term:`DISTROOVERRIDES` to add extra overrides that should
  1736. apply to the distribution.
  1737. The underlying mechanism behind :term:`DISTROOVERRIDES` is simply that it
  1738. is included in the default value of
  1739. :term:`OVERRIDES`.
  1740. Here is an example from :yocto_git:`meta-poky/conf/distro/poky-tiny.conf
  1741. </poky/tree/meta-poky/conf/distro/poky-tiny.conf>`::
  1742. DISTROOVERRIDES = "poky:poky-tiny"
  1743. :term:`DL_DIR`
  1744. The central download directory used by the build process to store
  1745. downloads. By default, :term:`DL_DIR` gets files suitable for mirroring
  1746. for everything except Git repositories. If you want tarballs of Git
  1747. repositories, use the
  1748. :term:`BB_GENERATE_MIRROR_TARBALLS`
  1749. variable.
  1750. You can set this directory by defining the :term:`DL_DIR` variable in the
  1751. ``conf/local.conf`` file. This directory is self-maintaining and you
  1752. should not have to touch it. By default, the directory is
  1753. ``downloads`` in the :term:`Build Directory`::
  1754. #DL_DIR ?= "${TOPDIR}/downloads"
  1755. To specify a different download directory,
  1756. simply remove the comment from the line and provide your directory.
  1757. During a first build, the system downloads many different source code
  1758. tarballs from various upstream projects. Downloading can take a
  1759. while, particularly if your network connection is slow. Tarballs are
  1760. all stored in the directory defined by :term:`DL_DIR` and the build
  1761. system looks there first to find source tarballs.
  1762. .. note::
  1763. When wiping and rebuilding, you can preserve this directory to
  1764. speed up this part of subsequent builds.
  1765. You can safely share this directory between multiple builds on the
  1766. same development machine. For additional information on how the build
  1767. process gets source files when working behind a firewall or proxy
  1768. server, see this specific question in the ":doc:`faq`"
  1769. chapter. You can also refer to the
  1770. ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
  1771. Wiki page.
  1772. :term:`DOC_COMPRESS`
  1773. When inheriting the :ref:`ref-classes-compress_doc`
  1774. class, this variable sets the compression policy used when the
  1775. OpenEmbedded build system compresses man pages and info pages. By
  1776. default, the compression method used is gz (gzip). Other policies
  1777. available are xz and bz2.
  1778. For information on policies and on how to use this variable, see the
  1779. comments in the ``meta/classes-recipe/compress_doc.bbclass`` file.
  1780. :term:`DT_FILES`
  1781. Space-separated list of device tree source files to compile using
  1782. a recipe that inherits the :ref:`ref-classes-devicetree` class. These
  1783. are relative to the :term:`DT_FILES_PATH`.
  1784. For convenience, both ``.dts`` and ``.dtb`` extensions can be used.
  1785. Use an empty string (default) to build all device tree sources within
  1786. the :term:`DT_FILES_PATH` directory.
  1787. :term:`DT_FILES_PATH`
  1788. When compiling out-of-tree device tree sources using a recipe that
  1789. inherits the :ref:`ref-classes-devicetree` class, this variable specifies
  1790. the path to the directory containing dts files to build.
  1791. Defaults to the :term:`S` directory.
  1792. :term:`DT_PADDING_SIZE`
  1793. When inheriting the :ref:`ref-classes-devicetree` class, this variable
  1794. specifies the size of padding appended to the device tree blob, used as
  1795. extra space typically for additional properties during boot.
  1796. :term:`EFI_PROVIDER`
  1797. When building bootable images (i.e. where ``hddimg``, ``iso``, or
  1798. ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the
  1799. :term:`EFI_PROVIDER` variable specifies the EFI bootloader to use. The
  1800. default is "grub-efi", but "systemd-boot" can be used instead.
  1801. See the :ref:`ref-classes-systemd-boot` and :ref:`ref-classes-image-live`
  1802. classes for more information.
  1803. :term:`ENABLE_BINARY_LOCALE_GENERATION`
  1804. Variable that controls which locales for ``glibc`` are generated
  1805. during the build (useful if the target device has 64Mbytes of RAM or
  1806. less).
  1807. :term:`ERR_REPORT_DIR`
  1808. When used with the :ref:`ref-classes-report-error` class, specifies the
  1809. path used for storing the debug files created by the :ref:`error reporting
  1810. tool <dev-manual/error-reporting-tool:using the error reporting tool>`,
  1811. which allows you to submit build errors you encounter to a central
  1812. database. By default, the value of this variable is
  1813. ``${``\ :term:`LOG_DIR`\ ``}/error-report``.
  1814. You can set :term:`ERR_REPORT_DIR` to the path you want the error
  1815. reporting tool to store the debug files as follows in your
  1816. ``local.conf`` file::
  1817. ERR_REPORT_DIR = "path"
  1818. :term:`ERROR_QA`
  1819. Specifies the quality assurance checks whose failures are reported as
  1820. errors by the OpenEmbedded build system. You set this variable in
  1821. your distribution configuration file. For a list of the checks you
  1822. can control with this variable, see the
  1823. ":ref:`ref-classes-insane`" section.
  1824. :term:`ESDK_CLASS_INHERIT_DISABLE`
  1825. A list of classes to remove from the :term:`INHERIT`
  1826. value globally within the extensible SDK configuration. The
  1827. :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the
  1828. default value::
  1829. ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc"
  1830. Some classes are not generally applicable within the extensible SDK
  1831. context. You can use this variable to disable those classes.
  1832. For additional information on how to customize the extensible SDK's
  1833. configuration, see the
  1834. ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
  1835. section in the Yocto Project Application Development and the
  1836. Extensible Software Development Kit (eSDK) manual.
  1837. :term:`ESDK_LOCALCONF_ALLOW`
  1838. A list of variables allowed through from the OpenEmbedded build
  1839. system configuration into the extensible SDK configuration. By
  1840. default, the list of variables is empty and is set in the
  1841. :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
  1842. This list overrides the variables specified using the
  1843. :term:`ESDK_LOCALCONF_REMOVE` variable as well as
  1844. other variables automatically added due to the "/" character
  1845. being found at the start of the
  1846. value, which is usually indicative of being a path and thus might not
  1847. be valid on the system where the SDK is installed.
  1848. For additional information on how to customize the extensible SDK's
  1849. configuration, see the
  1850. ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
  1851. section in the Yocto Project Application Development and the
  1852. Extensible Software Development Kit (eSDK) manual.
  1853. :term:`ESDK_LOCALCONF_REMOVE`
  1854. A list of variables not allowed through from the OpenEmbedded build
  1855. system configuration into the extensible SDK configuration. Usually,
  1856. these are variables that are specific to the machine on which the
  1857. build system is running and thus would be potentially problematic
  1858. within the extensible SDK.
  1859. By default, :term:`ESDK_LOCALCONF_REMOVE` is set in the
  1860. :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and
  1861. excludes the following variables:
  1862. - :term:`CONF_VERSION`
  1863. - :term:`BB_NUMBER_THREADS`
  1864. - :term:`BB_NUMBER_PARSE_THREADS`
  1865. - :term:`PARALLEL_MAKE`
  1866. - :term:`PRSERV_HOST`
  1867. - :term:`SSTATE_MIRRORS` :term:`DL_DIR`
  1868. - :term:`SSTATE_DIR` :term:`TMPDIR`
  1869. - :term:`BB_SERVER_TIMEOUT`
  1870. For additional information on how to customize the extensible SDK's
  1871. configuration, see the
  1872. ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
  1873. section in the Yocto Project Application Development and the
  1874. Extensible Software Development Kit (eSDK) manual.
  1875. :term:`EXCLUDE_FROM_SHLIBS`
  1876. Triggers the OpenEmbedded build system's shared libraries resolver to
  1877. exclude an entire package when scanning for shared libraries.
  1878. .. note::
  1879. The shared libraries resolver's functionality results in part from
  1880. the internal function ``package_do_shlibs``, which is part of the
  1881. :ref:`ref-tasks-package` task. You should be aware that the shared
  1882. libraries resolver might implicitly define some dependencies between
  1883. packages.
  1884. The :term:`EXCLUDE_FROM_SHLIBS` variable is similar to the
  1885. :term:`PRIVATE_LIBS` variable, which excludes a
  1886. package's particular libraries only and not the whole package.
  1887. Use the :term:`EXCLUDE_FROM_SHLIBS` variable by setting it to "1" for a
  1888. particular package::
  1889. EXCLUDE_FROM_SHLIBS = "1"
  1890. :term:`EXCLUDE_FROM_WORLD`
  1891. Directs BitBake to exclude a recipe from world builds (i.e.
  1892. ``bitbake world``). During world builds, BitBake locates, parses and
  1893. builds all recipes found in every layer exposed in the
  1894. ``bblayers.conf`` configuration file.
  1895. To exclude a recipe from a world build using this variable, set the
  1896. variable to "1" in the recipe.
  1897. .. note::
  1898. Recipes added to :term:`EXCLUDE_FROM_WORLD` may still be built during a
  1899. world build in order to satisfy dependencies of other recipes. Adding
  1900. a recipe to :term:`EXCLUDE_FROM_WORLD` only ensures that the recipe is not
  1901. explicitly added to the list of build targets in a world build.
  1902. :term:`EXTENDPE`
  1903. Used with file and pathnames to create a prefix for a recipe's
  1904. version based on the recipe's :term:`PE` value. If :term:`PE`
  1905. is set and greater than zero for a recipe, :term:`EXTENDPE` becomes that
  1906. value (e.g if :term:`PE` is equal to "1" then :term:`EXTENDPE` becomes "1").
  1907. If a recipe's :term:`PE` is not set (the default) or is equal to zero,
  1908. :term:`EXTENDPE` becomes "".
  1909. See the :term:`STAMP` variable for an example.
  1910. :term:`EXTENDPKGV`
  1911. The full package version specification as it appears on the final
  1912. packages produced by a recipe. The variable's value is normally used
  1913. to fix a runtime dependency to the exact same version of another
  1914. package in the same recipe::
  1915. RDEPENDS:${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
  1916. The dependency relationships are intended to force the package
  1917. manager to upgrade these types of packages in lock-step.
  1918. :term:`EXTERNAL_KERNEL_TOOLS`
  1919. When set, the :term:`EXTERNAL_KERNEL_TOOLS` variable indicates that these
  1920. tools are not in the source tree.
  1921. When kernel tools are available in the tree, they are preferred over
  1922. any externally installed tools. Setting the :term:`EXTERNAL_KERNEL_TOOLS`
  1923. variable tells the OpenEmbedded build system to prefer the installed
  1924. external tools. See the :ref:`ref-classes-kernel-yocto` class in
  1925. ``meta/classes-recipe`` to see how the variable is used.
  1926. :term:`KERNEL_LOCALVERSION`
  1927. This variable allows to append a string to the version
  1928. of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION``
  1929. kernel configuration parameter.
  1930. Using this variable is only useful when you are using a kernel recipe
  1931. inheriting the :ref:`ref-classes-kernel` class, and which doesn't
  1932. already set a local version. Therefore, setting this variable has no
  1933. impact on ``linux-yocto`` kernels.
  1934. :term:`EXTERNAL_TOOLCHAIN`
  1935. When you intend to use an
  1936. :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`,
  1937. this variable allows to specify the directory where this toolchain was
  1938. installed.
  1939. :term:`EXTERNALSRC`
  1940. When inheriting the :ref:`ref-classes-externalsrc`
  1941. class, this variable points to the source tree, which is outside of
  1942. the OpenEmbedded build system. When set, this variable sets the
  1943. :term:`S` variable, which is what the OpenEmbedded build
  1944. system uses to locate unpacked recipe source code.
  1945. See the ":ref:`ref-classes-externalsrc`" section for details. You
  1946. can also find information on how to use this variable in the
  1947. ":ref:`dev-manual/building:building software from an external source`"
  1948. section in the Yocto Project Development Tasks Manual.
  1949. :term:`EXTERNALSRC_BUILD`
  1950. When inheriting the :ref:`ref-classes-externalsrc`
  1951. class, this variable points to the directory in which the recipe's
  1952. source code is built, which is outside of the OpenEmbedded build
  1953. system. When set, this variable sets the :term:`B` variable,
  1954. which is what the OpenEmbedded build system uses to locate the
  1955. :term:`Build Directory`.
  1956. See the ":ref:`ref-classes-externalsrc`" section for details. You
  1957. can also find information on how to use this variable in the
  1958. ":ref:`dev-manual/building:building software from an external source`"
  1959. section in the Yocto Project Development Tasks Manual.
  1960. :term:`EXTRA_AUTORECONF`
  1961. For recipes inheriting the :ref:`ref-classes-autotools`
  1962. class, you can use :term:`EXTRA_AUTORECONF` to specify extra options to
  1963. pass to the ``autoreconf`` command that is executed during the
  1964. :ref:`ref-tasks-configure` task.
  1965. The default value is "--exclude=autopoint".
  1966. :term:`EXTRA_IMAGE_FEATURES`
  1967. A list of additional features to include in an image. When listing
  1968. more than one feature, separate them with a space.
  1969. Typically, you configure this variable in your ``local.conf`` file,
  1970. which is found in the :term:`Build Directory`. Although you can use this
  1971. variable from within a recipe, best practices dictate that you do not.
  1972. .. note::
  1973. To enable primary features from within the image recipe, use the
  1974. :term:`IMAGE_FEATURES` variable.
  1975. Here are some examples of features you can add:
  1976. - "dbg-pkgs" --- adds -dbg packages for all installed packages including
  1977. symbol information for debugging and profiling.
  1978. - "debug-tweaks" --- makes an image suitable for debugging. For example, allows root logins without passwords and
  1979. enables post-installation logging. See the 'allow-empty-password' and
  1980. 'post-install-logging' features in the ":ref:`ref-features-image`"
  1981. section for more information.
  1982. - "dev-pkgs" --- adds -dev packages for all installed packages. This is
  1983. useful if you want to develop against the libraries in the image.
  1984. - "read-only-rootfs" --- creates an image whose root filesystem is
  1985. read-only. See the
  1986. ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`"
  1987. section in the Yocto Project Development Tasks Manual for more
  1988. information
  1989. - "tools-debug" --- adds debugging tools such as gdb and strace.
  1990. - "tools-sdk" --- adds development tools such as gcc, make,
  1991. pkgconfig and so forth.
  1992. - "tools-testapps" --- adds useful testing tools
  1993. such as ts_print, aplay, arecord and so forth.
  1994. For a complete list of image features that ships with the Yocto
  1995. Project, see the ":ref:`ref-features-image`" section.
  1996. For an example that shows how to customize your image by using this
  1997. variable, see the ":ref:`dev-manual/customizing-images:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
  1998. section in the Yocto Project Development Tasks Manual.
  1999. :term:`EXTRA_IMAGECMD`
  2000. Specifies additional options for the image creation command that has
  2001. been specified in :term:`IMAGE_CMD`. When setting
  2002. this variable, use an override for the associated image type. Here is
  2003. an example::
  2004. EXTRA_IMAGECMD:ext3 ?= "-i 4096"
  2005. :term:`EXTRA_IMAGEDEPENDS`
  2006. A list of recipes to build that do not provide packages for
  2007. installing into the root filesystem.
  2008. Sometimes a recipe is required to build the final image but is not
  2009. needed in the root filesystem. You can use the :term:`EXTRA_IMAGEDEPENDS`
  2010. variable to list these recipes and thus specify the dependencies. A
  2011. typical example is a required bootloader in a machine configuration.
  2012. .. note::
  2013. To add packages to the root filesystem, see the various
  2014. :term:`RDEPENDS` and :term:`RRECOMMENDS` variables.
  2015. :term:`EXTRA_OECMAKE`
  2016. Additional `CMake <https://cmake.org/overview/>`__ options. See the
  2017. :ref:`ref-classes-cmake` class for additional information.
  2018. :term:`EXTRA_OECONF`
  2019. Additional ``configure`` script options. See
  2020. :term:`PACKAGECONFIG_CONFARGS` for
  2021. additional information on passing configure script options.
  2022. :term:`EXTRA_OEMAKE`
  2023. Additional GNU ``make`` options.
  2024. Because the :term:`EXTRA_OEMAKE` defaults to "", you need to set the
  2025. variable to specify any required GNU options.
  2026. :term:`PARALLEL_MAKE` and
  2027. :term:`PARALLEL_MAKEINST` also make use of
  2028. :term:`EXTRA_OEMAKE` to pass the required flags.
  2029. :term:`EXTRA_OESCONS`
  2030. When inheriting the :ref:`ref-classes-scons` class, this
  2031. variable specifies additional configuration options you want to pass
  2032. to the ``scons`` command line.
  2033. :term:`EXTRA_OEMESON`
  2034. Additional `Meson <https://mesonbuild.com/>`__ options. See the
  2035. :ref:`ref-classes-meson` class for additional information.
  2036. In addition to standard Meson options, such options correspond to
  2037. `Meson build options <https://mesonbuild.com/Build-options.html>`__
  2038. defined in the ``meson_options.txt`` file in the sources to build.
  2039. Here is an example::
  2040. EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled"
  2041. Note that any custom value for the Meson ``--buildtype`` option
  2042. should be set through the :term:`MESON_BUILDTYPE` variable.
  2043. :term:`EXTRA_USERS_PARAMS`
  2044. When inheriting the :ref:`ref-classes-extrausers`
  2045. class, this variable provides image level user and group operations.
  2046. This is a more global method of providing user and group
  2047. configuration as compared to using the
  2048. :ref:`ref-classes-useradd` class, which ties user and
  2049. group configurations to a specific recipe.
  2050. The set list of commands you can configure using the
  2051. :term:`EXTRA_USERS_PARAMS` is shown in the
  2052. :ref:`ref-classes-extrausers` class. These commands map to the normal
  2053. Unix commands of the same names::
  2054. # EXTRA_USERS_PARAMS = "\
  2055. # useradd -p '' tester; \
  2056. # groupadd developers; \
  2057. # userdel nobody; \
  2058. # groupdel -g video; \
  2059. # groupmod -g 1020 developers; \
  2060. # usermod -s /bin/sh tester; \
  2061. # "
  2062. Hardcoded passwords are supported via the ``-p`` parameters for
  2063. ``useradd`` or ``usermod``, but only hashed.
  2064. Here is an example that adds two users named "tester-jim" and "tester-sue" and assigns
  2065. passwords. First on host, create the (escaped) password hash::
  2066. printf "%q" $(mkpasswd -m sha256crypt tester01)
  2067. The resulting hash is set to a variable and used in ``useradd`` command parameters::
  2068. inherit extrausers
  2069. PASSWD = "\$X\$ABC123\$A-Long-Hash"
  2070. EXTRA_USERS_PARAMS = "\
  2071. useradd -p '${PASSWD}' tester-jim; \
  2072. useradd -p '${PASSWD}' tester-sue; \
  2073. "
  2074. Finally, here is an example that sets the root password::
  2075. inherit extrausers
  2076. EXTRA_USERS_PARAMS = "\
  2077. usermod -p '${PASSWD}' root; \
  2078. "
  2079. .. note::
  2080. From a security perspective, hardcoding a default password is not
  2081. generally a good idea or even legal in some jurisdictions. It is
  2082. recommended that you do not do this if you are building a production
  2083. image.
  2084. Additionally there is a special ``passwd-expire`` command that will
  2085. cause the password for a user to be expired and thus force changing it
  2086. on first login, for example::
  2087. EXTRA_USERS_PARAMS += " useradd myuser; passwd-expire myuser;"
  2088. .. note::
  2089. At present, ``passwd-expire`` may only work for remote logins when
  2090. using OpenSSH and not dropbear as an SSH server.
  2091. :term:`EXTRANATIVEPATH`
  2092. A list of subdirectories of
  2093. ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}``
  2094. added to the beginning of the environment variable ``PATH``. As an
  2095. example, the following prepends
  2096. "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to
  2097. ``PATH``::
  2098. EXTRANATIVEPATH = "foo bar"
  2099. :term:`FAKEROOT`
  2100. See :term:`bitbake:FAKEROOT` in the BitBake manual.
  2101. :term:`FAKEROOTBASEENV`
  2102. See :term:`bitbake:FAKEROOTBASEENV` in the BitBake manual.
  2103. :term:`FAKEROOTCMD`
  2104. See :term:`bitbake:FAKEROOTCMD` in the BitBake manual.
  2105. :term:`FAKEROOTDIRS`
  2106. See :term:`bitbake:FAKEROOTDIRS` in the BitBake manual.
  2107. :term:`FAKEROOTENV`
  2108. See :term:`bitbake:FAKEROOTENV` in the BitBake manual.
  2109. :term:`FAKEROOTNOENV`
  2110. See :term:`bitbake:FAKEROOTNOENV` in the BitBake manual.
  2111. :term:`FEATURE_PACKAGES`
  2112. Defines one or more packages to include in an image when a specific
  2113. item is included in :term:`IMAGE_FEATURES`.
  2114. When setting the value, :term:`FEATURE_PACKAGES` should have the name of
  2115. the feature item as an override. Here is an example::
  2116. FEATURE_PACKAGES_widget = "package1 package2"
  2117. In this example, if "widget" were added to :term:`IMAGE_FEATURES`,
  2118. package1 and package2 would be included in the image.
  2119. .. note::
  2120. Packages installed by features defined through :term:`FEATURE_PACKAGES`
  2121. are often package groups. While similarly named, you should not
  2122. confuse the :term:`FEATURE_PACKAGES` variable with package groups, which
  2123. are discussed elsewhere in the documentation.
  2124. :term:`FEED_DEPLOYDIR_BASE_URI`
  2125. Points to the base URL of the server and location within the
  2126. document-root that provides the metadata and packages required by
  2127. OPKG to support runtime package management of IPK packages. You set
  2128. this variable in your ``local.conf`` file.
  2129. Consider the following example::
  2130. FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir"
  2131. This example assumes you are serving
  2132. your packages over HTTP and your databases are located in a directory
  2133. named ``BOARD-dir``, which is underneath your HTTP server's
  2134. document-root. In this case, the OpenEmbedded build system generates
  2135. a set of configuration files for you in your target that work with
  2136. the feed.
  2137. :term:`FETCHCMD`
  2138. See :term:`bitbake:FETCHCMD` in the BitBake manual.
  2139. :term:`FILE`
  2140. See :term:`bitbake:FILE` in the BitBake manual.
  2141. :term:`FILES`
  2142. The list of files and directories that are placed in a package. The
  2143. :term:`PACKAGES` variable lists the packages
  2144. generated by a recipe.
  2145. To use the :term:`FILES` variable, provide a package name override that
  2146. identifies the resulting package. Then, provide a space-separated
  2147. list of files or paths that identify the files you want included as
  2148. part of the resulting package. Here is an example::
  2149. FILES:${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile"
  2150. .. note::
  2151. - When specifying files or paths, you can pattern match using
  2152. Python's
  2153. `glob <https://docs.python.org/3/library/glob.html>`__
  2154. syntax. For details on the syntax, see the documentation by
  2155. following the previous link.
  2156. - When specifying paths as part of the :term:`FILES` variable, it is
  2157. good practice to use appropriate path variables. For example,
  2158. use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}``
  2159. rather than ``/usr/bin``. You can find a list of these
  2160. variables at the top of the ``meta/conf/bitbake.conf`` file in
  2161. the :term:`Source Directory`. You will also
  2162. find the default values of the various ``FILES:*`` variables in
  2163. this file.
  2164. If some of the files you provide with the :term:`FILES` variable are
  2165. editable and you know they should not be overwritten during the
  2166. package update process by the Package Management System (PMS), you
  2167. can identify these files so that the PMS will not overwrite them. See
  2168. the :term:`CONFFILES` variable for information on
  2169. how to identify these files to the PMS.
  2170. :term:`FILES_SOLIBSDEV`
  2171. Defines the file specification to match
  2172. :term:`SOLIBSDEV`. In other words,
  2173. :term:`FILES_SOLIBSDEV` defines the full path name of the development
  2174. symbolic link (symlink) for shared libraries on the target platform.
  2175. The following statement from the ``bitbake.conf`` shows how it is
  2176. set::
  2177. FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}"
  2178. :term:`FILESEXTRAPATHS`
  2179. A colon-separated list to extend the search path the OpenEmbedded build
  2180. system uses when looking for files and patches as it processes recipes
  2181. and append files. The default directories BitBake uses when it processes
  2182. recipes are initially defined by the :term:`FILESPATH` variable. You can
  2183. extend :term:`FILESPATH` variable by using :term:`FILESEXTRAPATHS`.
  2184. Best practices dictate that you accomplish this by using
  2185. :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you
  2186. prepend paths as follows::
  2187. FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"
  2188. In the above example, the build system first
  2189. looks for files in a directory that has the same name as the
  2190. corresponding append file.
  2191. .. note::
  2192. When extending :term:`FILESEXTRAPATHS`, be sure to use the immediate
  2193. expansion (``:=``) operator. Immediate expansion makes sure that
  2194. BitBake evaluates :term:`THISDIR` at the time the
  2195. directive is encountered rather than at some later time when
  2196. expansion might result in a directory that does not contain the
  2197. files you need.
  2198. Also, include the trailing separating colon character if you are
  2199. prepending. The trailing colon character is necessary because you
  2200. are directing BitBake to extend the path by prepending directories
  2201. to the search path.
  2202. Here is another common use::
  2203. FILESEXTRAPATHS:prepend := "${THISDIR}/files:"
  2204. In this example, the build system extends the
  2205. :term:`FILESPATH` variable to include a directory named ``files`` that is
  2206. in the same directory as the corresponding append file.
  2207. This next example specifically adds three paths::
  2208. FILESEXTRAPATHS:prepend := "path_1:path_2:path_3:"
  2209. A final example shows how you can extend the search path and include
  2210. a :term:`MACHINE`-specific override, which is useful
  2211. in a BSP layer::
  2212. FILESEXTRAPATHS:prepend:intel-x86-common := "${THISDIR}/${PN}:"
  2213. The previous statement appears in the
  2214. ``linux-yocto-dev.bbappend`` file, which is found in the
  2215. :ref:`overview-manual/development-environment:yocto project source repositories` in
  2216. ``meta-intel/common/recipes-kernel/linux``. Here, the machine
  2217. override is a special :term:`PACKAGE_ARCH`
  2218. definition for multiple ``meta-intel`` machines.
  2219. .. note::
  2220. For a layer that supports a single BSP, the override could just be
  2221. the value of :term:`MACHINE`.
  2222. By prepending paths in ``.bbappend`` files, you allow multiple append
  2223. files that reside in different layers but are used for the same
  2224. recipe to correctly extend the path.
  2225. :term:`FILESOVERRIDES`
  2226. A colon-separated list to specify a subset of :term:`OVERRIDES` used by
  2227. the OpenEmbedded build system for creating :term:`FILESPATH`. The
  2228. :term:`FILESOVERRIDES` variable uses overrides to automatically extend
  2229. the :term:`FILESPATH` variable. For an example of how that works, see the
  2230. :term:`FILESPATH` variable description. Additionally, you find more
  2231. information on how overrides are handled in the
  2232. ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
  2233. section of the BitBake User Manual.
  2234. By default, the :term:`FILESOVERRIDES` variable is defined as::
  2235. FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}"
  2236. .. note::
  2237. Do not hand-edit the :term:`FILESOVERRIDES` variable. The values match up
  2238. with expected overrides and are used in an expected manner by the
  2239. build system.
  2240. :term:`FILESPATH`
  2241. A colon-separated list specifying the default set of directories the
  2242. OpenEmbedded build system uses when searching for patches and files.
  2243. During the build process, BitBake searches each directory in
  2244. :term:`FILESPATH` in the specified order when looking for files and
  2245. patches specified by each ``file://`` URI in a recipe's
  2246. :term:`SRC_URI` statements.
  2247. The default value for the :term:`FILESPATH` variable is defined in the
  2248. :ref:`ref-classes-base` class found in ``meta/classes-global`` in the
  2249. :term:`Source Directory`::
  2250. FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
  2251. "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
  2252. The
  2253. :term:`FILESPATH` variable is automatically extended using the overrides
  2254. from the :term:`FILESOVERRIDES` variable.
  2255. .. note::
  2256. - Do not hand-edit the :term:`FILESPATH` variable. If you want the
  2257. build system to look in directories other than the defaults,
  2258. extend the :term:`FILESPATH` variable by using the
  2259. :term:`FILESEXTRAPATHS` variable.
  2260. - Be aware that the default :term:`FILESPATH` directories do not map
  2261. to directories in custom layers where append files
  2262. (``.bbappend``) are used. If you want the build system to find
  2263. patches or files that reside with your append files, you need
  2264. to extend the :term:`FILESPATH` variable by using the
  2265. :term:`FILESEXTRAPATHS` variable.
  2266. You can take advantage of this searching behavior in useful ways. For
  2267. example, consider a case where there is the following directory structure
  2268. for general and machine-specific configurations::
  2269. files/defconfig
  2270. files/MACHINEA/defconfig
  2271. files/MACHINEB/defconfig
  2272. Also in the example, the :term:`SRC_URI` statement contains
  2273. "file://defconfig". Given this scenario, you can set
  2274. :term:`MACHINE` to "MACHINEA" and cause the build
  2275. system to use files from ``files/MACHINEA``. Set :term:`MACHINE` to
  2276. "MACHINEB" and the build system uses files from ``files/MACHINEB``.
  2277. Finally, for any machine other than "MACHINEA" and "MACHINEB", the
  2278. build system uses files from ``files/defconfig``.
  2279. You can find out more about the patching process in the
  2280. ":ref:`overview-manual/concepts:patching`" section
  2281. in the Yocto Project Overview and Concepts Manual and the
  2282. ":ref:`dev-manual/new-recipe:patching code`" section in
  2283. the Yocto Project Development Tasks Manual. See the
  2284. :ref:`ref-tasks-patch` task as well.
  2285. :term:`FILESYSTEM_PERMS_TABLES`
  2286. Allows you to define your own file permissions settings table as part
  2287. of your configuration for the packaging process. For example, suppose
  2288. you need a consistent set of custom permissions for a set of groups
  2289. and users across an entire work project. It is best to do this in the
  2290. packages themselves but this is not always possible.
  2291. By default, the OpenEmbedded build system uses the ``fs-perms.txt``,
  2292. which is located in the ``meta/files`` folder in the :term:`Source Directory`.
  2293. If you create your own file
  2294. permissions setting table, you should place it in your layer or the
  2295. distro's layer.
  2296. You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
  2297. ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
  2298. to point to your custom ``fs-perms.txt``. You can specify more than a
  2299. single file permissions setting table. The paths you specify to these
  2300. files must be defined within the :term:`BBPATH` variable.
  2301. For guidance on how to create your own file permissions settings
  2302. table file, examine the existing ``fs-perms.txt``.
  2303. :term:`FIT_ADDRESS_CELLS`
  2304. Specifies the value of the ``#address-cells`` value for the
  2305. description of the FIT image.
  2306. The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage`
  2307. class, which corresponds to 32 bit addresses.
  2308. For platforms that need to set 64 bit addresses, for example in
  2309. :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to
  2310. set this value to "2", as two 32 bit values (cells) will be needed
  2311. to represent such addresses.
  2312. Here is an example setting "0x400000000" as a load address::
  2313. FIT_ADDRESS_CELLS = "2"
  2314. UBOOT_LOADADDRESS= "0x04 0x00000000"
  2315. See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__.
  2316. :term:`FIT_CONF_DEFAULT_DTB`
  2317. Specifies the default device tree binary (dtb) file for a FIT image
  2318. when multiple ones are provided.
  2319. This variable is used in the :ref:`ref-classes-kernel-fitimage` class.
  2320. :term:`FIT_DESC`
  2321. Specifies the description string encoded into a FIT image. The
  2322. default value is set by the :ref:`ref-classes-kernel-fitimage` class as
  2323. follows::
  2324. FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}"
  2325. :term:`FIT_GENERATE_KEYS`
  2326. Decides whether to generate the keys for signing the FIT image if
  2327. they don't already exist. The keys are created in
  2328. :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0"
  2329. by the :ref:`ref-classes-kernel-fitimage` class.
  2330. :term:`FIT_HASH_ALG`
  2331. Specifies the hash algorithm used in creating the FIT Image.
  2332. This variable is set by default to "sha256" by the
  2333. :ref:`ref-classes-kernel-fitimage` class.
  2334. :term:`FIT_KERNEL_COMP_ALG`
  2335. The compression algorithm to use for the kernel image inside the FIT Image.
  2336. At present, the only supported values are "gzip" (default), "lzo" or "none".
  2337. If you set this variable to anything other than "none" you may also need
  2338. to set :term:`FIT_KERNEL_COMP_ALG_EXTENSION`.
  2339. This variable is used in the :ref:`ref-classes-kernel-uboot` class.
  2340. :term:`FIT_KERNEL_COMP_ALG_EXTENSION`
  2341. File extension corresponding to :term:`FIT_KERNEL_COMP_ALG`. The default
  2342. value is set ".gz" by the :ref:`ref-classes-kernel-uboot` class. If you
  2343. set :term:`FIT_KERNEL_COMP_ALG` to "lzo", you may want to set this
  2344. variable to ".lzo".
  2345. :term:`FIT_KEY_GENRSA_ARGS`
  2346. Arguments to ``openssl genrsa`` for generating a RSA private key for
  2347. signing the FIT image. The default value is set to "-F4" by the
  2348. :ref:`ref-classes-kernel-fitimage` class.
  2349. :term:`FIT_KEY_REQ_ARGS`
  2350. Arguments to ``openssl req`` for generating a certificate for signing
  2351. the FIT image. The default value is "-batch -new" by the
  2352. :ref:`ref-classes-kernel-fitimage` class, "batch" for
  2353. non interactive mode and "new" for generating new keys.
  2354. :term:`FIT_KEY_SIGN_PKCS`
  2355. Format for the public key certificate used for signing the FIT image.
  2356. The default value is set to "x509" by the
  2357. :ref:`ref-classes-kernel-fitimage` class.
  2358. :term:`FIT_SIGN_ALG`
  2359. Specifies the signature algorithm used in creating the FIT Image.
  2360. This variable is set by default to "rsa2048" by the
  2361. :ref:`ref-classes-kernel-fitimage` class.
  2362. :term:`FIT_PAD_ALG`
  2363. Specifies the padding algorithm used in creating the FIT Image.
  2364. The default value is set to "pkcs-1.5" by the
  2365. :ref:`ref-classes-kernel-fitimage` class.
  2366. :term:`FIT_SIGN_INDIVIDUAL`
  2367. If set to "1", then the :ref:`ref-classes-kernel-fitimage`
  2368. class will sign the kernel, dtb and ramdisk images individually in addition
  2369. to signing the FIT image itself. This could be useful if you are
  2370. intending to verify signatures in another context than booting via
  2371. U-Boot.
  2372. This variable is set to "0" by default.
  2373. :term:`FIT_SIGN_NUMBITS`
  2374. Size of the private key used in the FIT image, in number of bits.
  2375. The default value for this variable is set to "2048"
  2376. by the :ref:`ref-classes-kernel-fitimage` class.
  2377. :term:`FONT_EXTRA_RDEPENDS`
  2378. When inheriting the :ref:`ref-classes-fontcache` class,
  2379. this variable specifies the runtime dependencies for font packages.
  2380. By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils".
  2381. :term:`FONT_PACKAGES`
  2382. When inheriting the :ref:`ref-classes-fontcache` class, this variable
  2383. identifies packages containing font files that need to be cached by
  2384. Fontconfig. By default, the :ref:`ref-classes-fontcache` class assumes
  2385. that fonts are in the recipe's main package (i.e.
  2386. ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
  2387. need are in a package other than that main package.
  2388. :term:`FORCE_RO_REMOVE`
  2389. Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED``
  2390. during the generation of the root filesystem.
  2391. Set the variable to "1" to force the removal of these packages.
  2392. :term:`FULL_OPTIMIZATION`
  2393. The options to pass in :term:`TARGET_CFLAGS` and :term:`CFLAGS` when
  2394. compiling an optimized system. This variable defaults to "-O2 -pipe
  2395. ${DEBUG_FLAGS}".
  2396. :term:`GCCPIE`
  2397. Enables Position Independent Executables (PIE) within the GNU C
  2398. Compiler (GCC). Enabling PIE in the GCC makes Return Oriented
  2399. Programming (ROP) attacks much more difficult to execute.
  2400. By default the ``security_flags.inc`` file enables PIE by setting the
  2401. variable as follows::
  2402. GCCPIE ?= "--enable-default-pie"
  2403. :term:`GCCVERSION`
  2404. Specifies the default version of the GNU C Compiler (GCC) used for
  2405. compilation. By default, :term:`GCCVERSION` is set to "8.x" in the
  2406. ``meta/conf/distro/include/tcmode-default.inc`` include file::
  2407. GCCVERSION ?= "8.%"
  2408. You can override this value by setting it in a
  2409. configuration file such as the ``local.conf``.
  2410. :term:`GDB`
  2411. The minimal command and arguments to run the GNU Debugger.
  2412. :term:`GIR_EXTRA_LIBS_PATH`
  2413. Allows to specify an extra search path for ``.so`` files
  2414. in GLib related recipes using GObject introspection,
  2415. and which do not compile without this setting.
  2416. See the ":ref:`dev-manual/gobject-introspection:enabling gobject introspection support`"
  2417. section for details.
  2418. :term:`GITDIR`
  2419. The directory in which a local copy of a Git repository is stored
  2420. when it is cloned.
  2421. :term:`GITHUB_BASE_URI`
  2422. When inheriting the :ref:`ref-classes-github-releases`
  2423. class, specifies the base URL for fetching releases for the github
  2424. project you wish to fetch sources from. The default value is as follows::
  2425. GITHUB_BASE_URI ?= "https://github.com/${BPN}/${BPN}/releases/"
  2426. :term:`GLIBC_GENERATE_LOCALES`
  2427. Specifies the list of GLIBC locales to generate should you not wish
  2428. to generate all LIBC locals, which can be time consuming.
  2429. .. note::
  2430. If you specifically remove the locale ``en_US.UTF-8``, you must set
  2431. :term:`IMAGE_LINGUAS` appropriately.
  2432. You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file.
  2433. By default, all locales are generated::
  2434. GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8"
  2435. :term:`GO_IMPORT`
  2436. When inheriting the :ref:`ref-classes-go` class, this mandatory variable
  2437. sets the import path for the Go package that will be created for the code
  2438. to build. If you have a ``go.mod`` file in the source directory, this
  2439. typically matches the path in the ``module`` line in this file.
  2440. Other Go programs importing this package will use this path.
  2441. Here is an example setting from the
  2442. :yocto_git:`go-helloworld_0.1.bb </poky/tree/meta/recipes-extended/go-examples/go-helloworld_0.1.bb>`
  2443. recipe::
  2444. GO_IMPORT = "golang.org/x/example"
  2445. :term:`GO_INSTALL`
  2446. When inheriting the :ref:`ref-classes-go` class, this optional variable
  2447. specifies which packages in the sources should be compiled and
  2448. installed in the Go build space by the
  2449. `go install <https://go.dev/ref/mod#go-install>`__ command.
  2450. Here is an example setting from the
  2451. :oe_git:`crucible </meta-openembedded/tree/meta-oe/recipes-support/crucible/>`
  2452. recipe::
  2453. GO_INSTALL = "\
  2454. ${GO_IMPORT}/cmd/crucible \
  2455. ${GO_IMPORT}/cmd/habtool \
  2456. "
  2457. By default, :term:`GO_INSTALL` is defined as::
  2458. GO_INSTALL ?= "${GO_IMPORT}/..."
  2459. The ``...`` wildcard means that it will catch all
  2460. packages found in the sources.
  2461. See the :term:`GO_INSTALL_FILTEROUT` variable for
  2462. filtering out unwanted packages from the ones
  2463. found from the :term:`GO_INSTALL` value.
  2464. :term:`GO_INSTALL_FILTEROUT`
  2465. When using the Go "vendor" mechanism to bring in dependencies for a Go
  2466. package, the default :term:`GO_INSTALL` setting, which uses the ``...``
  2467. wildcard, will include the vendored packages in the build, which produces
  2468. incorrect results.
  2469. There are also some Go packages that are structured poorly, so that the
  2470. ``...`` wildcard results in building example or test code that should not
  2471. be included in the build, or could fail to build.
  2472. This optional variable allows for filtering out a subset of the sources.
  2473. It defaults to excluding everything under the ``vendor`` subdirectory
  2474. under package's main directory. This is the normal location for vendored
  2475. packages, but it can be overridden by a recipe to filter out other
  2476. subdirectories if needed.
  2477. :term:`GO_WORKDIR`
  2478. When using Go Modules, the current working directory must be the directory
  2479. containing the ``go.mod`` file, or one of its subdirectories. When the
  2480. ``go`` tool is used, it will automatically look for the ``go.mod`` file
  2481. in the Go working directory or in any parent directory, but not in
  2482. subdirectories.
  2483. When using the :ref:`ref-classes-go-mod` class to use Go modules,
  2484. the optional :term:`GO_WORKDIR` variable, defaulting to the value
  2485. of :term:`GO_IMPORT`, allows to specify a different Go working directory.
  2486. :term:`GROUPADD_PARAM`
  2487. When inheriting the :ref:`ref-classes-useradd` class,
  2488. this variable specifies for a package what parameters should be
  2489. passed to the ``groupadd`` command if you wish to add a group to the
  2490. system when the package is installed.
  2491. Here is an example from the ``dbus`` recipe::
  2492. GROUPADD_PARAM:${PN} = "-r netdev"
  2493. More than one group can be added by separating each set of different
  2494. groups' parameters with a semicolon.
  2495. Here is an example adding multiple groups from the ``useradd-example.bb``
  2496. file in the ``meta-skeleton`` layer::
  2497. GROUPADD_PARAM:${PN} = "-g 880 group1; -g 890 group2"
  2498. For information on the standard Linux shell command
  2499. ``groupadd``, see https://linux.die.net/man/8/groupadd.
  2500. :term:`GROUPMEMS_PARAM`
  2501. When inheriting the :ref:`ref-classes-useradd` class,
  2502. this variable specifies for a package what parameters should be
  2503. passed to the ``groupmems`` command if you wish to modify the members
  2504. of a group when the package is installed.
  2505. For information on the standard Linux shell command ``groupmems``,
  2506. see https://linux.die.net/man/8/groupmems.
  2507. :term:`GRUB_GFXSERIAL`
  2508. Configures the GNU GRand Unified Bootloader (GRUB) to have graphics
  2509. and serial in the boot menu. Set this variable to "1" in your
  2510. ``local.conf`` or distribution configuration file to enable graphics
  2511. and serial in the menu.
  2512. See the :ref:`ref-classes-grub-efi` class for more
  2513. information on how this variable is used.
  2514. :term:`GRUB_OPTS`
  2515. Additional options to add to the GNU GRand Unified Bootloader (GRUB)
  2516. configuration. Use a semi-colon character (``;``) to separate
  2517. multiple options.
  2518. The :term:`GRUB_OPTS` variable is optional. See the
  2519. :ref:`ref-classes-grub-efi` class for more information
  2520. on how this variable is used.
  2521. :term:`GRUB_TIMEOUT`
  2522. Specifies the timeout before executing the default ``LABEL`` in the
  2523. GNU GRand Unified Bootloader (GRUB).
  2524. The :term:`GRUB_TIMEOUT` variable is optional. See the
  2525. :ref:`ref-classes-grub-efi` class for more information
  2526. on how this variable is used.
  2527. :term:`GTKIMMODULES_PACKAGES`
  2528. When inheriting the :ref:`ref-classes-gtk-immodules-cache` class,
  2529. this variable specifies the packages that contain the GTK+ input
  2530. method modules being installed when the modules are in packages other
  2531. than the main package.
  2532. :term:`HGDIR`
  2533. See :term:`bitbake:HGDIR` in the BitBake manual.
  2534. :term:`HOMEPAGE`
  2535. Website where more information about the software the recipe is
  2536. building can be found.
  2537. :term:`HOST_ARCH`
  2538. The name of the target architecture, which is normally the same as
  2539. :term:`TARGET_ARCH`. The OpenEmbedded build system
  2540. supports many architectures. Here is an example list of architectures
  2541. supported. This list is by no means complete as the architecture is
  2542. configurable:
  2543. - arm
  2544. - i586
  2545. - x86_64
  2546. - powerpc
  2547. - powerpc64
  2548. - mips
  2549. - mipsel
  2550. :term:`HOST_CC_ARCH`
  2551. Specifies architecture-specific compiler flags that are passed to the
  2552. C compiler.
  2553. Default initialization for :term:`HOST_CC_ARCH` varies depending on what
  2554. is being built:
  2555. - :term:`TARGET_CC_ARCH` when building for the
  2556. target
  2557. - :term:`BUILD_CC_ARCH` when building for the build host (i.e.
  2558. ``-native``)
  2559. - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e.
  2560. ``nativesdk-``)
  2561. :term:`HOST_OS`
  2562. Specifies the name of the target operating system, which is normally
  2563. the same as the :term:`TARGET_OS`. The variable can
  2564. be set to "linux" for ``glibc``-based systems and to "linux-musl" for
  2565. ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and
  2566. "linux-musleabi" values possible.
  2567. :term:`HOST_PREFIX`
  2568. Specifies the prefix for the cross-compile toolchain. :term:`HOST_PREFIX`
  2569. is normally the same as :term:`TARGET_PREFIX`.
  2570. :term:`HOST_SYS`
  2571. Specifies the system, including the architecture and the operating
  2572. system, for which the build is occurring in the context of the
  2573. current recipe.
  2574. The OpenEmbedded build system automatically sets this variable based
  2575. on :term:`HOST_ARCH`,
  2576. :term:`HOST_VENDOR`, and
  2577. :term:`HOST_OS` variables.
  2578. .. note::
  2579. You do not need to set the variable yourself.
  2580. Consider these two examples:
  2581. - Given a native recipe on a 32-bit x86 machine running Linux, the
  2582. value is "i686-linux".
  2583. - Given a recipe being built for a little-endian MIPS target running
  2584. Linux, the value might be "mipsel-linux".
  2585. :term:`HOST_VENDOR`
  2586. Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the
  2587. same as :term:`TARGET_VENDOR`.
  2588. :term:`HOSTTOOLS`
  2589. A space-separated list (filter) of tools on the build host that
  2590. should be allowed to be called from within build tasks. Using this
  2591. filter helps reduce the possibility of host contamination. If a tool
  2592. specified in the value of :term:`HOSTTOOLS` is not found on the build
  2593. host, the OpenEmbedded build system produces an error and the build
  2594. is not started.
  2595. For additional information, see
  2596. :term:`HOSTTOOLS_NONFATAL`.
  2597. :term:`HOSTTOOLS_NONFATAL`
  2598. A space-separated list (filter) of tools on the build host that
  2599. should be allowed to be called from within build tasks. Using this
  2600. filter helps reduce the possibility of host contamination. Unlike
  2601. :term:`HOSTTOOLS`, the OpenEmbedded build system
  2602. does not produce an error if a tool specified in the value of
  2603. :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can
  2604. use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools.
  2605. :term:`ICECC_CLASS_DISABLE`
  2606. Identifies user classes that you do not want the Icecream distributed
  2607. compile support to consider. This variable is used by the
  2608. :ref:`ref-classes-icecc` class. You set this variable in
  2609. your ``local.conf`` file.
  2610. When you list classes using this variable, the recipes inheriting
  2611. those classes will not benefit from distributed compilation across
  2612. remote hosts. Instead they will be built locally.
  2613. :term:`ICECC_DISABLED`
  2614. Disables or enables the ``icecc`` (Icecream) function. For more
  2615. information on this function and best practices for using this
  2616. variable, see the ":ref:`ref-classes-icecc`"
  2617. section.
  2618. Setting this variable to "1" in your ``local.conf`` disables the
  2619. function::
  2620. ICECC_DISABLED ??= "1"
  2621. To enable the function, set the variable as follows::
  2622. ICECC_DISABLED = ""
  2623. :term:`ICECC_ENV_EXEC`
  2624. Points to the ``icecc-create-env`` script that you provide. This
  2625. variable is used by the :ref:`ref-classes-icecc` class. You
  2626. set this variable in your ``local.conf`` file.
  2627. If you do not point to a script that you provide, the OpenEmbedded
  2628. build system uses the default script provided by the
  2629. :oe_git:`icecc-create-env_0.1.bb
  2630. </openembedded-core/tree/meta/recipes-devtools/icecc-create-env/icecc-create-env_0.1.bb>`
  2631. recipe, which is a modified version and not the one that comes with
  2632. ``icecream``.
  2633. :term:`ICECC_PARALLEL_MAKE`
  2634. Extra options passed to the ``make`` command during the
  2635. :ref:`ref-tasks-compile` task that specify parallel
  2636. compilation. This variable usually takes the form of "-j x", where x
  2637. represents the maximum number of parallel threads ``make`` can run.
  2638. .. note::
  2639. The options passed affect builds on all enabled machines on the
  2640. network, which are machines running the ``iceccd`` daemon.
  2641. If your enabled machines support multiple cores, coming up with the
  2642. maximum number of parallel threads that gives you the best
  2643. performance could take some experimentation since machine speed,
  2644. network lag, available memory, and existing machine loads can all
  2645. affect build time. Consequently, unlike the
  2646. :term:`PARALLEL_MAKE` variable, there is no
  2647. rule-of-thumb for setting :term:`ICECC_PARALLEL_MAKE` to achieve optimal
  2648. performance.
  2649. If you do not set :term:`ICECC_PARALLEL_MAKE`, the build system does not
  2650. use it (i.e. the system does not detect and assign the number of
  2651. cores as is done with :term:`PARALLEL_MAKE`).
  2652. :term:`ICECC_PATH`
  2653. The location of the ``icecc`` binary. You can set this variable in
  2654. your ``local.conf`` file. If your ``local.conf`` file does not define
  2655. this variable, the :ref:`ref-classes-icecc` class attempts
  2656. to define it by locating ``icecc`` using ``which``.
  2657. :term:`ICECC_RECIPE_DISABLE`
  2658. Identifies user recipes that you do not want the Icecream distributed
  2659. compile support to consider. This variable is used by the
  2660. :ref:`ref-classes-icecc` class. You set this variable in
  2661. your ``local.conf`` file.
  2662. When you list recipes using this variable, you are excluding them
  2663. from distributed compilation across remote hosts. Instead they will
  2664. be built locally.
  2665. :term:`ICECC_RECIPE_ENABLE`
  2666. Identifies user recipes that use an empty
  2667. :term:`PARALLEL_MAKE` variable that you want to
  2668. force remote distributed compilation on using the Icecream
  2669. distributed compile support. This variable is used by the
  2670. :ref:`ref-classes-icecc` class. You set this variable in
  2671. your ``local.conf`` file.
  2672. :term:`IMAGE_BASENAME`
  2673. The base name of image output files. This variable defaults to the
  2674. recipe name (``${``\ :term:`PN`\ ``}``).
  2675. :term:`IMAGE_BOOT_FILES`
  2676. A space-separated list of files installed into the boot partition
  2677. when preparing an image using the Wic tool with the
  2678. ``bootimg-partition`` source plugin. By default,
  2679. the files are
  2680. installed under the same name as the source files. To change the
  2681. installed name, separate it from the original name with a semi-colon
  2682. (;). Source files need to be located in
  2683. :term:`DEPLOY_DIR_IMAGE`. Here are two
  2684. examples::
  2685. IMAGE_BOOT_FILES = "u-boot.img uImage;kernel"
  2686. IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}"
  2687. Alternatively, source files can be picked up using a glob pattern. In
  2688. this case, the destination file must have the same name as the base
  2689. name of the source file path. To install files into a directory
  2690. within the target location, pass its name after a semi-colon (;).
  2691. Here are two examples::
  2692. IMAGE_BOOT_FILES = "bcm2835-bootfiles/*"
  2693. IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/"
  2694. The first example
  2695. installs all files from ``${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles``
  2696. into the root of the target partition. The second example installs
  2697. the same files into a ``boot`` directory within the target partition.
  2698. You can find information on how to use the Wic tool in the
  2699. ":ref:`dev-manual/wic:creating partitioned images using wic`"
  2700. section of the Yocto Project Development Tasks Manual. Reference
  2701. material for Wic is located in the
  2702. ":doc:`/ref-manual/kickstart`" chapter.
  2703. :term:`IMAGE_BUILDINFO_FILE`
  2704. When using the :ref:`ref-classes-image-buildinfo` class,
  2705. specifies the file in the image to write the build information into. The
  2706. default value is "``${sysconfdir}/buildinfo``".
  2707. :term:`IMAGE_BUILDINFO_VARS`
  2708. When using the :ref:`ref-classes-image-buildinfo` class,
  2709. specifies the list of variables to include in the `Build Configuration`
  2710. section of the output file (as a space-separated list). Defaults to
  2711. ":term:`DISTRO` :term:`DISTRO_VERSION`".
  2712. :term:`IMAGE_CLASSES`
  2713. A list of classes that all images should inherit. This is typically used
  2714. to enable functionality across all image recipes.
  2715. Classes specified in :term:`IMAGE_CLASSES` must be located in the
  2716. ``classes-recipe/`` or ``classes/`` subdirectories.
  2717. :term:`IMAGE_CMD`
  2718. Specifies the command to create the image file for a specific image
  2719. type, which corresponds to the value set in
  2720. :term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
  2721. ``btrfs``, and so forth). When setting this variable, you should use
  2722. an override for the associated type. Here is an example::
  2723. IMAGE_CMD:jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime \
  2724. --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 \
  2725. ${EXTRA_IMAGECMD}"
  2726. You typically do not need to set this variable unless you are adding
  2727. support for a new image type. For more examples on how to set this
  2728. variable, see the :ref:`ref-classes-image_types`
  2729. class file, which is ``meta/classes-recipe/image_types.bbclass``.
  2730. :term:`IMAGE_DEVICE_TABLES`
  2731. Specifies one or more files that contain custom device tables that
  2732. are passed to the ``makedevs`` command as part of creating an image.
  2733. These files list basic device nodes that should be created under
  2734. ``/dev`` within the image. If :term:`IMAGE_DEVICE_TABLES` is not set,
  2735. ``files/device_table-minimal.txt`` is used, which is located by
  2736. :term:`BBPATH`. For details on how you should write
  2737. device table files, see ``meta/files/device_table-minimal.txt`` as an
  2738. example.
  2739. :term:`IMAGE_EFI_BOOT_FILES`
  2740. A space-separated list of files installed into the boot partition
  2741. when preparing an image using the Wic tool with the
  2742. ``bootimg-efi`` source plugin. By default,
  2743. the files are
  2744. installed under the same name as the source files. To change the
  2745. installed name, separate it from the original name with a semi-colon
  2746. (;). Source files need to be located in
  2747. :term:`DEPLOY_DIR_IMAGE`. Here are two
  2748. examples::
  2749. IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2"
  2750. IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio"
  2751. Alternatively, source files can be picked up using a glob pattern. In
  2752. this case, the destination file must have the same name as the base
  2753. name of the source file path. To install files into a directory
  2754. within the target location, pass its name after a semi-colon (;).
  2755. Here are two examples::
  2756. IMAGE_EFI_BOOT_FILES = "boot/loader/*"
  2757. IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/"
  2758. The first example
  2759. installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/``
  2760. into the root of the target partition. The second example installs
  2761. the same files into a ``boot`` directory within the target partition.
  2762. You can find information on how to use the Wic tool in the
  2763. ":ref:`dev-manual/wic:creating partitioned images using wic`"
  2764. section of the Yocto Project Development Tasks Manual. Reference
  2765. material for Wic is located in the
  2766. ":doc:`/ref-manual/kickstart`" chapter.
  2767. :term:`IMAGE_FEATURES`
  2768. The primary list of features to include in an image. Typically, you
  2769. configure this variable in an image recipe. Although you can use this
  2770. variable from your ``local.conf`` file, which is found in the
  2771. :term:`Build Directory`, best practices dictate that you do
  2772. not.
  2773. .. note::
  2774. To enable extra features from outside the image recipe, use the
  2775. :term:`EXTRA_IMAGE_FEATURES` variable.
  2776. For a list of image features that ships with the Yocto Project, see
  2777. the ":ref:`ref-features-image`" section.
  2778. For an example that shows how to customize your image by using this
  2779. variable, see the ":ref:`dev-manual/customizing-images:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
  2780. section in the Yocto Project Development Tasks Manual.
  2781. :term:`IMAGE_FSTYPES`
  2782. Specifies the formats the OpenEmbedded build system uses during the
  2783. build when creating the root filesystem. For example, setting
  2784. :term:`IMAGE_FSTYPES` as follows causes the build system to create root
  2785. filesystems using two formats: ``.ext3`` and ``.tar.bz2``::
  2786. IMAGE_FSTYPES = "ext3 tar.bz2"
  2787. For the complete list of supported image formats from which you can
  2788. choose, see :term:`IMAGE_TYPES`.
  2789. .. note::
  2790. - If an image recipe uses the "inherit image" line and you are
  2791. setting :term:`IMAGE_FSTYPES` inside the recipe, you must set
  2792. :term:`IMAGE_FSTYPES` prior to using the "inherit image" line.
  2793. - Due to the way the OpenEmbedded build system processes this
  2794. variable, you cannot update its contents by using ``:append``
  2795. or ``:prepend``. You must use the ``+=`` operator to add one or
  2796. more options to the :term:`IMAGE_FSTYPES` variable.
  2797. :term:`IMAGE_INSTALL`
  2798. Used by recipes to specify the packages to install into an image
  2799. through the :ref:`ref-classes-image` class. Use the
  2800. :term:`IMAGE_INSTALL` variable with care to avoid ordering issues.
  2801. Image recipes set :term:`IMAGE_INSTALL` to specify the packages to
  2802. install into an image through :ref:`ref-classes-image`. Additionally,
  2803. there are "helper" classes such as the :ref:`ref-classes-core-image`
  2804. class which can take lists used with :term:`IMAGE_FEATURES` and turn
  2805. them into auto-generated entries in :term:`IMAGE_INSTALL` in addition
  2806. to its default contents.
  2807. When you use this variable, it is best to use it as follows::
  2808. IMAGE_INSTALL:append = " package-name"
  2809. Be sure to include the space
  2810. between the quotation character and the start of the package name or
  2811. names.
  2812. .. note::
  2813. - When working with a
  2814. :ref:`core-image-minimal-initramfs <ref-manual/images:images>`
  2815. image, do not use the :term:`IMAGE_INSTALL` variable to specify
  2816. packages for installation. Instead, use the
  2817. :term:`PACKAGE_INSTALL` variable, which
  2818. allows the initial RAM filesystem (:term:`Initramfs`) recipe to use a
  2819. fixed set of packages and not be affected by :term:`IMAGE_INSTALL`.
  2820. For information on creating an :term:`Initramfs`, see the
  2821. ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`"
  2822. section in the Yocto Project Development Tasks Manual.
  2823. - Using :term:`IMAGE_INSTALL` with the
  2824. :ref:`+= <bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>`
  2825. BitBake operator within the ``/conf/local.conf`` file or from
  2826. within an image recipe is not recommended. Use of this operator in
  2827. these ways can cause ordering issues. Since
  2828. :ref:`ref-classes-core-image` sets :term:`IMAGE_INSTALL` to a
  2829. default value using the
  2830. :ref:`?= <bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>`
  2831. operator, using a ``+=`` operation against :term:`IMAGE_INSTALL`
  2832. results in unexpected behavior when used within
  2833. ``conf/local.conf``. Furthermore, the same operation from within an
  2834. image recipe may or may not succeed depending on the specific
  2835. situation. In both these cases, the behavior is contrary to how
  2836. most users expect the ``+=`` operator to work.
  2837. :term:`IMAGE_LINGUAS`
  2838. Specifies the list of locales to install into the image during the
  2839. root filesystem construction process. The OpenEmbedded build system
  2840. automatically splits locale files, which are used for localization,
  2841. into separate packages. Setting the :term:`IMAGE_LINGUAS` variable
  2842. ensures that any locale packages that correspond to packages already
  2843. selected for installation into the image are also installed. Here is
  2844. an example::
  2845. IMAGE_LINGUAS = "pt-br de-de"
  2846. In this example, the build system ensures any Brazilian Portuguese
  2847. and German locale files that correspond to packages in the image are
  2848. installed (i.e. ``*-locale-pt-br`` and ``*-locale-de-de`` as well as
  2849. ``*-locale-pt`` and ``*-locale-de``, since some software packages
  2850. only provide locale files by language and not by country-specific
  2851. language).
  2852. See the :term:`GLIBC_GENERATE_LOCALES`
  2853. variable for information on generating GLIBC locales.
  2854. :term:`IMAGE_LINK_NAME`
  2855. The name of the output image symlink (which does not include
  2856. the version part as :term:`IMAGE_NAME` does). The default value
  2857. is derived using the :term:`IMAGE_BASENAME` and
  2858. :term:`IMAGE_MACHINE_SUFFIX` variables::
  2859. IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}"
  2860. .. note::
  2861. It is possible to set this to "" to disable symlink creation,
  2862. however, you also need to set :term:`IMAGE_NAME` to still have
  2863. a reasonable value e.g.::
  2864. IMAGE_LINK_NAME = ""
  2865. IMAGE_NAME = "${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}${IMAGE_VERSION_SUFFIX}"
  2866. :term:`IMAGE_MACHINE_SUFFIX`
  2867. Specifies the by default machine-specific suffix for image file names
  2868. (before the extension). The default value is set as follows::
  2869. IMAGE_MACHINE_SUFFIX ??= "-${MACHINE}"
  2870. The default :term:`DEPLOY_DIR_IMAGE` already has a :term:`MACHINE`
  2871. subdirectory, so you may find it unnecessary to also include this suffix
  2872. in the name of every image file. If you prefer to remove the suffix you
  2873. can set this variable to an empty string::
  2874. IMAGE_MACHINE_SUFFIX = ""
  2875. (Not to be confused with :term:`IMAGE_NAME_SUFFIX`.)
  2876. :term:`IMAGE_MANIFEST`
  2877. The manifest file for the image. This file lists all the installed
  2878. packages that make up the image. The file contains package
  2879. information on a line-per-package basis as follows::
  2880. packagename packagearch version
  2881. The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class defines the manifest
  2882. file as follows::
  2883. IMAGE_MANIFEST ="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest"
  2884. The location is
  2885. derived using the :term:`IMGDEPLOYDIR`
  2886. and :term:`IMAGE_NAME` variables. You can find
  2887. information on how the image is created in the ":ref:`overview-manual/concepts:image generation`"
  2888. section in the Yocto Project Overview and Concepts Manual.
  2889. :term:`IMAGE_NAME`
  2890. The name of the output image files minus the extension. By default
  2891. this variable is set using the :term:`IMAGE_LINK_NAME`, and
  2892. :term:`IMAGE_VERSION_SUFFIX` variables::
  2893. IMAGE_NAME ?= "${IMAGE_LINK_NAME}${IMAGE_VERSION_SUFFIX}"
  2894. :term:`IMAGE_NAME_SUFFIX`
  2895. Suffix used for the image output filename --- defaults to ``".rootfs"``
  2896. to distinguish the image file from other files created during image
  2897. building; however if this suffix is redundant or not desired you can
  2898. clear the value of this variable (set the value to ""). For example,
  2899. this is typically cleared in :term:`Initramfs` image recipes.
  2900. :term:`IMAGE_OVERHEAD_FACTOR`
  2901. Defines a multiplier that the build system applies to the initial
  2902. image size for cases when the multiplier times the returned disk
  2903. usage value for the image is greater than the sum of
  2904. :term:`IMAGE_ROOTFS_SIZE` and :term:`IMAGE_ROOTFS_EXTRA_SPACE`. The result of
  2905. the multiplier applied to the initial image size creates free disk
  2906. space in the image as overhead. By default, the build process uses a
  2907. multiplier of 1.3 for this variable. This default value results in
  2908. 30% free disk space added to the image when this method is used to
  2909. determine the final generated image size. You should be aware that
  2910. post install scripts and the package management system uses disk
  2911. space inside this overhead area. Consequently, the multiplier does
  2912. not produce an image with all the theoretical free disk space. See
  2913. :term:`IMAGE_ROOTFS_SIZE` for information on how the build system
  2914. determines the overall image size.
  2915. The default 30% free disk space typically gives the image enough room
  2916. to boot and allows for basic post installs while still leaving a
  2917. small amount of free disk space. If 30% free space is inadequate, you
  2918. can increase the default value. For example, the following setting
  2919. gives you 50% free space added to the image::
  2920. IMAGE_OVERHEAD_FACTOR = "1.5"
  2921. Alternatively, you can ensure a specific amount of free disk space is
  2922. added to the image by using the :term:`IMAGE_ROOTFS_EXTRA_SPACE`
  2923. variable.
  2924. :term:`IMAGE_PKGTYPE`
  2925. Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the
  2926. OpenEmbedded build system. The variable is defined appropriately by
  2927. the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`,
  2928. or :ref:`ref-classes-package_ipk` class.
  2929. The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image`
  2930. classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs.
  2931. You should not set the :term:`IMAGE_PKGTYPE` manually. Rather, the
  2932. variable is set indirectly through the appropriate
  2933. :ref:`package_* <ref-classes-package>` class using the
  2934. :term:`PACKAGE_CLASSES` variable. The
  2935. OpenEmbedded build system uses the first package type (e.g. DEB, RPM,
  2936. or IPK) that appears with the variable
  2937. .. note::
  2938. Files using the ``.tar`` format are never used as a substitute
  2939. packaging format for DEB, RPM, and IPK formatted files for your image
  2940. or SDK.
  2941. :term:`IMAGE_POSTPROCESS_COMMAND`
  2942. Specifies a list of functions to call once the OpenEmbedded build
  2943. system creates the final image output files. You can specify
  2944. functions separated by spaces::
  2945. IMAGE_POSTPROCESS_COMMAND += "function"
  2946. If you need to pass the root filesystem path to a command within the
  2947. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  2948. directory that becomes the root filesystem image. See the
  2949. :term:`IMAGE_ROOTFS` variable for more
  2950. information.
  2951. :term:`IMAGE_PREPROCESS_COMMAND`
  2952. Specifies a list of functions to call before the OpenEmbedded build
  2953. system creates the final image output files. You can specify
  2954. functions separated by spaces::
  2955. IMAGE_PREPROCESS_COMMAND += "function"
  2956. If you need to pass the root filesystem path to a command within the
  2957. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  2958. directory that becomes the root filesystem image. See the
  2959. :term:`IMAGE_ROOTFS` variable for more
  2960. information.
  2961. :term:`IMAGE_ROOTFS`
  2962. The location of the root filesystem while it is under construction
  2963. (i.e. during the :ref:`ref-tasks-rootfs` task). This
  2964. variable is not configurable. Do not change it.
  2965. :term:`IMAGE_ROOTFS_ALIGNMENT`
  2966. Specifies the alignment for the output image file in Kbytes. If the
  2967. size of the image is not a multiple of this value, then the size is
  2968. rounded up to the nearest multiple of the value. The default value is
  2969. "1". See :term:`IMAGE_ROOTFS_SIZE` for
  2970. additional information.
  2971. :term:`IMAGE_ROOTFS_EXTRA_SPACE`
  2972. Defines additional free disk space created in the image in Kbytes. By
  2973. default, this variable is set to "0". This free disk space is added
  2974. to the image after the build system determines the image size as
  2975. described in :term:`IMAGE_ROOTFS_SIZE`.
  2976. This variable is particularly useful when you want to ensure that a
  2977. specific amount of free disk space is available on a device after an
  2978. image is installed and running. For example, to be sure 5 Gbytes of
  2979. free disk space is available, set the variable as follows::
  2980. IMAGE_ROOTFS_EXTRA_SPACE = "5242880"
  2981. For example, the Yocto Project Build Appliance specifically requests
  2982. 40 Gbytes of extra space with the line::
  2983. IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
  2984. :term:`IMAGE_ROOTFS_SIZE`
  2985. Defines the size in Kbytes for the generated image. The OpenEmbedded
  2986. build system determines the final size for the generated image using
  2987. an algorithm that takes into account the initial disk space used for
  2988. the generated image, a requested size for the image, and requested
  2989. additional free disk space to be added to the image. Programatically,
  2990. the build system determines the final size of the generated image as
  2991. follows::
  2992. if (image-du * overhead) < rootfs-size:
  2993. internal-rootfs-size = rootfs-size + xspace
  2994. else:
  2995. internal-rootfs-size = (image-du * overhead) + xspace
  2996. where:
  2997. image-du = Returned value of the du command on the image.
  2998. overhead = IMAGE_OVERHEAD_FACTOR
  2999. rootfs-size = IMAGE_ROOTFS_SIZE
  3000. internal-rootfs-size = Initial root filesystem size before any modifications.
  3001. xspace = IMAGE_ROOTFS_EXTRA_SPACE
  3002. See the :term:`IMAGE_OVERHEAD_FACTOR`
  3003. and :term:`IMAGE_ROOTFS_EXTRA_SPACE`
  3004. variables for related information.
  3005. :term:`IMAGE_TYPEDEP`
  3006. Specifies a dependency from one image type on another. Here is an
  3007. example from the :ref:`ref-classes-image-live` class::
  3008. IMAGE_TYPEDEP:live = "ext3"
  3009. In the previous example, the variable ensures that when "live" is
  3010. listed with the :term:`IMAGE_FSTYPES` variable,
  3011. the OpenEmbedded build system produces an ``ext3`` image first since
  3012. one of the components of the live image is an ``ext3`` formatted
  3013. partition containing the root filesystem.
  3014. :term:`IMAGE_TYPES`
  3015. Specifies the complete list of supported image types by default:
  3016. - btrfs
  3017. - container
  3018. - cpio
  3019. - cpio.gz
  3020. - cpio.lz4
  3021. - cpio.lzma
  3022. - cpio.xz
  3023. - cramfs
  3024. - erofs
  3025. - erofs-lz4
  3026. - erofs-lz4hc
  3027. - ext2
  3028. - ext2.bz2
  3029. - ext2.gz
  3030. - ext2.lzma
  3031. - ext3
  3032. - ext3.gz
  3033. - ext4
  3034. - ext4.gz
  3035. - f2fs
  3036. - hddimg
  3037. - iso
  3038. - jffs2
  3039. - jffs2.sum
  3040. - multiubi
  3041. - squashfs
  3042. - squashfs-lz4
  3043. - squashfs-lzo
  3044. - squashfs-xz
  3045. - tar
  3046. - tar.bz2
  3047. - tar.gz
  3048. - tar.lz4
  3049. - tar.xz
  3050. - tar.zst
  3051. - ubi
  3052. - ubifs
  3053. - wic
  3054. - wic.bz2
  3055. - wic.gz
  3056. - wic.lzma
  3057. For more information about these types of images, see
  3058. ``meta/classes-recipe/image_types*.bbclass`` in the :term:`Source Directory`.
  3059. :term:`IMAGE_VERSION_SUFFIX`
  3060. Version suffix that is part of the default :term:`IMAGE_NAME` and
  3061. :term:`KERNEL_ARTIFACT_NAME` values.
  3062. Defaults to ``"-${DATETIME}"``, however you could set this to a
  3063. version string that comes from your external build environment if
  3064. desired, and this suffix would then be used consistently across
  3065. the build artifacts.
  3066. :term:`IMGDEPLOYDIR`
  3067. When inheriting the :ref:`ref-classes-image` class directly or
  3068. through the :ref:`ref-classes-core-image` class, the
  3069. :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files
  3070. that is set in the ``image`` class as follows::
  3071. IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete"
  3072. Recipes inheriting the :ref:`ref-classes-image` class should copy
  3073. files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take
  3074. care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
  3075. :term:`INCOMPATIBLE_LICENSE`
  3076. Specifies a space-separated list of license names (as they would
  3077. appear in :term:`LICENSE`) that should be excluded
  3078. from the build (if set globally), or from an image (if set locally
  3079. in an image recipe).
  3080. When the variable is set globally, recipes that provide no alternatives to listed
  3081. incompatible licenses are not built. Packages that are individually
  3082. licensed with the specified incompatible licenses will be deleted.
  3083. Most of the time this does not allow a feasible build (because it becomes impossible
  3084. to satisfy build time dependencies), so the recommended way to
  3085. implement license restrictions is to set the variable in specific
  3086. image recipes where the restrictions must apply. That way there
  3087. are no build time restrictions, but the license check is still
  3088. performed when the image's filesystem is assembled from packages.
  3089. There is some support for wildcards in this variable's value,
  3090. however it is restricted to specific licenses. Currently only
  3091. these wildcards are allowed and expand as follows:
  3092. - ``AGPL-3.0*"``: ``AGPL-3.0-only``, ``AGPL-3.0-or-later``
  3093. - ``GPL-3.0*``: ``GPL-3.0-only``, ``GPL-3.0-or-later``
  3094. - ``LGPL-3.0*``: ``LGPL-3.0-only``, ``LGPL-3.0-or-later``
  3095. .. note::
  3096. This functionality is only regularly tested using the following
  3097. setting::
  3098. INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0* AGPL-3.0*"
  3099. Although you can use other settings, you might be required to
  3100. remove dependencies on (or provide alternatives to) components that
  3101. are required to produce a functional system image.
  3102. :term:`INCOMPATIBLE_LICENSE_EXCEPTIONS`
  3103. Specifies a space-separated list of package and license pairs that
  3104. are allowed to be used even if the license is specified in
  3105. :term:`INCOMPATIBLE_LICENSE`. The package and license pairs are
  3106. separated using a colon. Example::
  3107. INCOMPATIBLE_LICENSE_EXCEPTIONS = "gdbserver:GPL-3.0-only gdbserver:LGPL-3.0-only"
  3108. :term:`INHERIT`
  3109. Causes the named class or classes to be inherited globally. Anonymous
  3110. functions in the class or classes are not executed for the base
  3111. configuration and in each individual recipe. The OpenEmbedded build
  3112. system ignores changes to :term:`INHERIT` in individual recipes.
  3113. Classes inherited using :term:`INHERIT` must be located in the
  3114. ``classes-global/`` or ``classes/`` subdirectories.
  3115. For more information on :term:`INHERIT`, see the
  3116. :ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
  3117. section in the BitBake User Manual.
  3118. :term:`INHERIT_DISTRO`
  3119. Lists classes that will be inherited at the distribution level. It is
  3120. unlikely that you want to edit this variable.
  3121. Classes specified in :term:`INHERIT_DISTRO` must be located in the
  3122. ``classes-global/`` or ``classes/`` subdirectories.
  3123. The default value of the variable is set as follows in the
  3124. ``meta/conf/distro/defaultsetup.conf`` file::
  3125. INHERIT_DISTRO ?= "debian devshell sstate license"
  3126. :term:`INHIBIT_DEFAULT_DEPS`
  3127. Prevents the default dependencies, namely the C compiler and standard
  3128. C library (libc), from being added to :term:`DEPENDS`.
  3129. This variable is usually used within recipes that do not require any
  3130. compilation using the C compiler.
  3131. Set the variable to "1" to prevent the default dependencies from
  3132. being added.
  3133. :term:`INHIBIT_PACKAGE_DEBUG_SPLIT`
  3134. Prevents the OpenEmbedded build system from splitting out debug
  3135. information during packaging. By default, the build system splits out
  3136. debugging information during the
  3137. :ref:`ref-tasks-package` task. For more information on
  3138. how debug information is split out, see the
  3139. :term:`PACKAGE_DEBUG_SPLIT_STYLE`
  3140. variable.
  3141. To prevent the build system from splitting out debug information
  3142. during packaging, set the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable as
  3143. follows::
  3144. INHIBIT_PACKAGE_DEBUG_SPLIT = "1"
  3145. :term:`INHIBIT_PACKAGE_STRIP`
  3146. If set to "1", causes the build to not strip binaries in resulting
  3147. packages and prevents the ``-dbg`` package from containing the source
  3148. files.
  3149. By default, the OpenEmbedded build system strips binaries and puts
  3150. the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``.
  3151. Consequently, you should not set :term:`INHIBIT_PACKAGE_STRIP` when you
  3152. plan to debug in general.
  3153. :term:`INHIBIT_SYSROOT_STRIP`
  3154. If set to "1", causes the build to not strip binaries in the
  3155. resulting sysroot.
  3156. By default, the OpenEmbedded build system strips binaries in the
  3157. resulting sysroot. When you specifically set the
  3158. :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit
  3159. this stripping.
  3160. If you want to use this variable, include the :ref:`ref-classes-staging`
  3161. class. This class uses a ``sys_strip()`` function to test for the variable
  3162. and acts accordingly.
  3163. .. note::
  3164. Use of the :term:`INHIBIT_SYSROOT_STRIP` variable occurs in rare and
  3165. special circumstances. For example, suppose you are building
  3166. bare-metal firmware by using an external GCC toolchain. Furthermore,
  3167. even if the toolchain's binaries are strippable, there are other files
  3168. needed for the build that are not strippable.
  3169. :term:`INIT_MANAGER`
  3170. Specifies the system init manager to use. Available options are:
  3171. - ``sysvinit``
  3172. - ``systemd``
  3173. - ``mdev-busybox``
  3174. With ``sysvinit``, the init manager is set to
  3175. :wikipedia:`SysVinit <Init#SysV-style>`, the traditional UNIX init
  3176. system. This is the default choice in the Poky distribution, together with
  3177. the Udev device manager (see the ":ref:`device-manager`" section).
  3178. With ``systemd``, the init manager becomes :wikipedia:`systemd <Systemd>`,
  3179. which comes with the :wikipedia:`udev <Udev>` device manager.
  3180. With ``mdev-busybox``, the init manager becomes the much simpler BusyBox
  3181. init, together with the BusyBox mdev device manager. This is the simplest
  3182. and lightest solution, and probably the best choice for low-end systems
  3183. with a rather slow CPU and a limited amount of RAM.
  3184. More concretely, this is used to include
  3185. ``conf/distro/include/init-manager-${INIT_MANAGER}.inc`` into the global
  3186. configuration. You can have a look at the
  3187. :yocto_git:`meta/conf/distro/include/init-manager-*.inc </poky/tree/meta/conf/distro/include>`
  3188. files for more information, and also the ":ref:`init-manager`"
  3189. section in the Yocto Project Development Tasks Manual.
  3190. :term:`INITRAMFS_DEPLOY_DIR_IMAGE`
  3191. Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs`
  3192. where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is
  3193. set by default to ``${DEPLOY_DIR_IMAGE}`` in the
  3194. :ref:`ref-classes-kernel` class and it's only meant to be changed when
  3195. building an :term:`Initramfs` image from a separate multiconfig via
  3196. :term:`INITRAMFS_MULTICONFIG`.
  3197. :term:`INITRAMFS_FSTYPES`
  3198. Defines the format for the output image of an initial RAM filesystem
  3199. (:term:`Initramfs`), which is used during boot. Supported formats are the
  3200. same as those supported by the
  3201. :term:`IMAGE_FSTYPES` variable.
  3202. The default value of this variable, which is set in the
  3203. ``meta/conf/bitbake.conf`` configuration file in the
  3204. :term:`Source Directory`, is "cpio.gz". The Linux kernel's
  3205. :term:`Initramfs` mechanism, as opposed to the initial RAM filesystem
  3206. :wikipedia:`initrd <Initrd>` mechanism, expects
  3207. an optionally compressed cpio archive.
  3208. :term:`INITRAMFS_IMAGE`
  3209. Specifies the :term:`PROVIDES` name of an image
  3210. recipe that is used to build an initial RAM filesystem (:term:`Initramfs`)
  3211. image. In other words, the :term:`INITRAMFS_IMAGE` variable causes an
  3212. additional recipe to be built as a dependency to whatever root
  3213. filesystem recipe you might be using (e.g. ``core-image-sato``). The
  3214. :term:`Initramfs` image recipe you provide should set
  3215. :term:`IMAGE_FSTYPES` to
  3216. :term:`INITRAMFS_FSTYPES`.
  3217. An :term:`Initramfs` image provides a temporary root filesystem used for
  3218. early system initialization (e.g. loading of modules needed to locate
  3219. and mount the "real" root filesystem).
  3220. .. note::
  3221. See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb``
  3222. recipe in the :term:`Source Directory`
  3223. for an example :term:`Initramfs` recipe. To select this sample recipe as
  3224. the one built to provide the :term:`Initramfs` image, set :term:`INITRAMFS_IMAGE`
  3225. to "core-image-minimal-initramfs".
  3226. You can also find more information by referencing the
  3227. ``meta-poky/conf/templates/default/local.conf.sample.extended``
  3228. configuration file in the Source Directory, the :ref:`ref-classes-image`
  3229. class, and the :ref:`ref-classes-kernel` class to see how to use the
  3230. :term:`INITRAMFS_IMAGE` variable.
  3231. If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no
  3232. :term:`Initramfs` image is built.
  3233. For more information, you can also see the
  3234. :term:`INITRAMFS_IMAGE_BUNDLE`
  3235. variable, which allows the generated image to be bundled inside the
  3236. kernel image. Additionally, for information on creating an :term:`Initramfs`
  3237. image, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section
  3238. in the Yocto Project Development Tasks Manual.
  3239. :term:`INITRAMFS_IMAGE_BUNDLE`
  3240. Controls whether or not the image recipe specified by
  3241. :term:`INITRAMFS_IMAGE` is run through an
  3242. extra pass
  3243. (:ref:`ref-tasks-bundle_initramfs`) during
  3244. kernel compilation in order to build a single binary that contains
  3245. both the kernel image and the initial RAM filesystem (:term:`Initramfs`)
  3246. image. This makes use of the
  3247. :term:`CONFIG_INITRAMFS_SOURCE` kernel
  3248. feature.
  3249. .. note::
  3250. Bundling the :term:`Initramfs` with the kernel conflates the code in the
  3251. :term:`Initramfs` with the GPLv2 licensed Linux kernel binary. Thus only GPLv2
  3252. compatible software may be part of a bundled :term:`Initramfs`.
  3253. .. note::
  3254. Using an extra compilation pass to bundle the :term:`Initramfs` avoids a
  3255. circular dependency between the kernel recipe and the :term:`Initramfs`
  3256. recipe should the :term:`Initramfs` include kernel modules. Should that be
  3257. the case, the :term:`Initramfs` recipe depends on the kernel for the
  3258. kernel modules, and the kernel depends on the :term:`Initramfs` recipe
  3259. since the :term:`Initramfs` is bundled inside the kernel image.
  3260. The combined binary is deposited into the ``tmp/deploy`` directory,
  3261. which is part of the :term:`Build Directory`.
  3262. Setting the variable to "1" in a configuration file causes the
  3263. OpenEmbedded build system to generate a kernel image with the
  3264. :term:`Initramfs` specified in :term:`INITRAMFS_IMAGE` bundled within::
  3265. INITRAMFS_IMAGE_BUNDLE = "1"
  3266. By default, the :ref:`ref-classes-kernel` class sets this variable to a
  3267. null string as follows::
  3268. INITRAMFS_IMAGE_BUNDLE ?= ""
  3269. .. note::
  3270. You must set the :term:`INITRAMFS_IMAGE_BUNDLE` variable in a
  3271. configuration file. You cannot set the variable in a recipe file.
  3272. See the
  3273. :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/templates/default/local.conf.sample.extended>`
  3274. file for additional information. Also, for information on creating an
  3275. :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section
  3276. in the Yocto Project Development Tasks Manual.
  3277. :term:`INITRAMFS_IMAGE_NAME`
  3278. This value needs to stay in sync with :term:`IMAGE_LINK_NAME`, but with
  3279. :term:`INITRAMFS_IMAGE` instead of :term:`IMAGE_BASENAME`. The default value
  3280. is set as follows:
  3281. INITRAMFS_IMAGE_NAME ?= "${@['${INITRAMFS_IMAGE}${IMAGE_MACHINE_SUFFIX}', ''][d.getVar('INITRAMFS_IMAGE') == '']}"
  3282. That is, if :term:`INITRAMFS_IMAGE` is set, the value of
  3283. :term:`INITRAMFS_IMAGE_NAME` will be set based upon
  3284. :term:`INITRAMFS_IMAGE` and :term:`IMAGE_MACHINE_SUFFIX`.
  3285. :term:`INITRAMFS_LINK_NAME`
  3286. The link name of the initial RAM filesystem image. This variable is
  3287. set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
  3288. follows::
  3289. INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}"
  3290. The value of the
  3291. ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
  3292. file, has the following value::
  3293. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3294. See the :term:`MACHINE` variable for additional
  3295. information.
  3296. :term:`INITRAMFS_MULTICONFIG`
  3297. Defines the multiconfig to create a multiconfig dependency to be used by
  3298. the :ref:`ref-classes-kernel` class.
  3299. This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from
  3300. a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`.
  3301. For more information on how to bundle an :term:`Initramfs` image from a separate
  3302. multiconfig see the ":ref:`dev-manual/building:Bundling an Initramfs Image From a Separate Multiconfig`"
  3303. section in the Yocto Project Development Tasks Manual.
  3304. :term:`INITRAMFS_NAME`
  3305. The base name of the initial RAM filesystem image. This variable is
  3306. set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
  3307. follows::
  3308. INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}"
  3309. See :term:`KERNEL_ARTIFACT_NAME` for additional information.
  3310. :term:`INITRD`
  3311. Indicates list of filesystem images to concatenate and use as an
  3312. initial RAM disk (``initrd``).
  3313. The :term:`INITRD` variable is an optional variable used with the
  3314. :ref:`ref-classes-image-live` class.
  3315. :term:`INITRD_IMAGE`
  3316. When building a "live" bootable image (i.e. when
  3317. :term:`IMAGE_FSTYPES` contains "live"),
  3318. :term:`INITRD_IMAGE` specifies the image recipe that should be built to
  3319. provide the initial RAM disk image. The default value is
  3320. "core-image-minimal-initramfs".
  3321. See the :ref:`ref-classes-image-live` class for more information.
  3322. :term:`INITSCRIPT_NAME`
  3323. The filename of the initialization script as installed to
  3324. ``${sysconfdir}/init.d``.
  3325. This variable is used in recipes when using :ref:`ref-classes-update-rc.d`.
  3326. The variable is mandatory.
  3327. :term:`INITSCRIPT_PACKAGES`
  3328. A list of the packages that contain initscripts. If multiple packages
  3329. are specified, you need to append the package name to the other
  3330. ``INITSCRIPT_*`` as an override.
  3331. This variable is used in recipes when using :ref:`ref-classes-update-rc.d`.
  3332. The variable is optional and defaults to the :term:`PN`
  3333. variable.
  3334. :term:`INITSCRIPT_PARAMS`
  3335. Specifies the options to pass to ``update-rc.d``. Here is an example::
  3336. INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ."
  3337. In this example, the script has a runlevel of 99, starts the script
  3338. in initlevels 2 and 5, and stops the script in levels 0, 1 and 6.
  3339. The variable's default value is "defaults", which is set in the
  3340. :ref:`ref-classes-update-rc.d` class.
  3341. The value in :term:`INITSCRIPT_PARAMS` is passed through to the
  3342. ``update-rc.d`` command. For more information on valid parameters,
  3343. please see the ``update-rc.d`` manual page at
  3344. https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
  3345. :term:`INSANE_SKIP`
  3346. Specifies the QA checks to skip for a specific package within a
  3347. recipe. For example, to skip the check for symbolic link ``.so``
  3348. files in the main package of a recipe, add the following to the
  3349. recipe. The package name override must be used, which in this example
  3350. is ``${PN}``::
  3351. INSANE_SKIP:${PN} += "dev-so"
  3352. See the ":ref:`ref-classes-insane`" section for a
  3353. list of the valid QA checks you can specify using this variable.
  3354. :term:`INSTALL_TIMEZONE_FILE`
  3355. By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file.
  3356. Set the :term:`INSTALL_TIMEZONE_FILE` variable to "0" at the
  3357. configuration level to disable this behavior.
  3358. :term:`IPK_FEED_URIS`
  3359. When the IPK backend is in use and package management is enabled on
  3360. the target, you can use this variable to set up ``opkg`` in the
  3361. target image to point to package feeds on a nominated server. Once
  3362. the feed is established, you can perform installations or upgrades
  3363. using the package manager at runtime.
  3364. :term:`KARCH`
  3365. Defines the kernel architecture used when assembling the
  3366. configuration. Architectures supported for this release are:
  3367. - powerpc
  3368. - i386
  3369. - x86_64
  3370. - arm
  3371. - qemu
  3372. - mips
  3373. You define the :term:`KARCH` variable in the :ref:`kernel-dev/advanced:bsp descriptions`.
  3374. :term:`KBRANCH`
  3375. A regular expression used by the build process to explicitly identify
  3376. the kernel branch that is validated, patched, and configured during a
  3377. build. You must set this variable to ensure the exact kernel branch
  3378. you want is being used by the build process.
  3379. Values for this variable are set in the kernel's recipe file and the
  3380. kernel's append file. For example, if you are using the
  3381. ``linux-yocto_4.12`` kernel, the kernel recipe file is the
  3382. ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. :term:`KBRANCH`
  3383. is set as follows in that kernel recipe file::
  3384. KBRANCH ?= "standard/base"
  3385. This variable is also used from the kernel's append file to identify
  3386. the kernel branch specific to a particular machine or target
  3387. hardware. Continuing with the previous kernel example, the kernel's
  3388. append file is located in the
  3389. BSP layer for a given machine. For example, the append file for the
  3390. Beaglebone and generic versions of both 32 and 64-bit IA
  3391. machines (``meta-yocto-bsp``) is named
  3392. ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_6.1.bbappend``.
  3393. Here are the related statements from that append file::
  3394. KBRANCH:genericx86 = "v6.1/standard/base"
  3395. KBRANCH:genericx86-64 = "v6.1/standard/base"
  3396. KBRANCH:beaglebone-yocto = "v6.1/standard/beaglebone"
  3397. The :term:`KBRANCH` statements
  3398. identify the kernel branch to use when building for each supported
  3399. BSP.
  3400. :term:`KBUILD_DEFCONFIG`
  3401. When used with the :ref:`ref-classes-kernel-yocto`
  3402. class, specifies an "in-tree" kernel configuration file for use
  3403. during a kernel build.
  3404. Typically, when using a ``defconfig`` to configure a kernel during a
  3405. build, you place the file in your layer in the same manner as you
  3406. would place patch files and configuration fragment files (i.e.
  3407. "out-of-tree"). However, if you want to use a ``defconfig`` file that
  3408. is part of the kernel tree (i.e. "in-tree"), you can use the
  3409. :term:`KBUILD_DEFCONFIG` variable and append the
  3410. :term:`KMACHINE` variable to point to the
  3411. ``defconfig`` file.
  3412. To use the variable, set it in the append file for your kernel recipe
  3413. using the following form::
  3414. KBUILD_DEFCONFIG:<machine> ?= "defconfig_file"
  3415. Here is an example from a "raspberrypi2" :term:`MACHINE` build that uses
  3416. a ``defconfig`` file named "bcm2709_defconfig"::
  3417. KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig"
  3418. As an alternative, you can use the following within your append file::
  3419. KBUILD_DEFCONFIG:pn-linux-yocto ?= "defconfig_file"
  3420. For more
  3421. information on how to use the :term:`KBUILD_DEFCONFIG` variable, see the
  3422. ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`"
  3423. section in the Yocto Project Linux Kernel Development Manual.
  3424. :term:`KCONFIG_MODE`
  3425. When used with the :ref:`ref-classes-kernel-yocto`
  3426. class, specifies the kernel configuration values to use for options
  3427. not specified in the provided ``defconfig`` file. Valid options are::
  3428. KCONFIG_MODE = "alldefconfig"
  3429. KCONFIG_MODE = "allnoconfig"
  3430. In ``alldefconfig`` mode the options not explicitly specified will be
  3431. assigned their Kconfig default value. In ``allnoconfig`` mode the
  3432. options not explicitly specified will be disabled in the kernel
  3433. config.
  3434. In case :term:`KCONFIG_MODE` is not set the behaviour will depend on where
  3435. the ``defconfig`` file is coming from. An "in-tree" ``defconfig`` file
  3436. will be handled in ``alldefconfig`` mode, a ``defconfig`` file placed
  3437. in ``${WORKDIR}`` through a meta-layer will be handled in
  3438. ``allnoconfig`` mode.
  3439. An "in-tree" ``defconfig`` file can be selected via the
  3440. :term:`KBUILD_DEFCONFIG` variable. :term:`KCONFIG_MODE` does not need to
  3441. be explicitly set.
  3442. A ``defconfig`` file compatible with ``allnoconfig`` mode can be
  3443. generated by copying the ``.config`` file from a working Linux kernel
  3444. build, renaming it to ``defconfig`` and placing it into the Linux
  3445. kernel ``${WORKDIR}`` through your meta-layer. :term:`KCONFIG_MODE` does
  3446. not need to be explicitly set.
  3447. A ``defconfig`` file compatible with ``alldefconfig`` mode can be
  3448. generated using the
  3449. :ref:`ref-tasks-savedefconfig`
  3450. task and placed into the Linux kernel ``${WORKDIR}`` through your
  3451. meta-layer. Explicitely set :term:`KCONFIG_MODE`::
  3452. KCONFIG_MODE = "alldefconfig"
  3453. :term:`KERNEL_ALT_IMAGETYPE`
  3454. Specifies an alternate kernel image type for creation in addition to
  3455. the kernel image type specified using the :term:`KERNEL_IMAGETYPE` and
  3456. :term:`KERNEL_IMAGETYPES` variables.
  3457. :term:`KERNEL_ARTIFACT_NAME`
  3458. Specifies the name of all of the build artifacts. You can change the
  3459. name of the artifacts by changing the :term:`KERNEL_ARTIFACT_NAME`
  3460. variable.
  3461. The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the
  3462. ``meta/classes-recipe/kernel-artifact-names.bbclass`` file, has the
  3463. following default value::
  3464. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}${IMAGE_MACHINE_SUFFIX}${IMAGE_VERSION_SUFFIX}"
  3465. See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`IMAGE_MACHINE_SUFFIX`
  3466. and :term:`IMAGE_VERSION_SUFFIX` variables for additional information.
  3467. :term:`KERNEL_CLASSES`
  3468. A list of classes defining kernel image types that the
  3469. :ref:`ref-classes-kernel` class should inherit. You typically
  3470. append this variable to enable extended image types. An example is
  3471. ":ref:`ref-classes-kernel-fitimage`", which enables
  3472. FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``.
  3473. You can register custom kernel image types with the
  3474. :ref:`ref-classes-kernel` class using this variable.
  3475. :term:`KERNEL_DANGLING_FEATURES_WARN_ONLY`
  3476. When kernel configuration fragments are missing for some
  3477. :term:`KERNEL_FEATURES` specified by layers or BSPs,
  3478. building and configuring the kernel stops with an error.
  3479. You can turn these errors into warnings by setting the
  3480. following in ``conf/local.conf``::
  3481. KERNEL_DANGLING_FEATURES_WARN_ONLY = "1"
  3482. You will still be warned that runtime issues may occur,
  3483. but at least the kernel configuration and build process will
  3484. be allowed to continue.
  3485. :term:`KERNEL_DEBUG_TIMESTAMPS`
  3486. If set to "1", enables timestamping functionality during building
  3487. the kernel. The default is "0" to disable this for reproducibility
  3488. reasons.
  3489. :term:`KERNEL_DEPLOY_DEPEND`
  3490. Provides a means of controlling the dependency of an image recipe
  3491. on the kernel. The default value is "virtual/kernel:do_deploy",
  3492. however for a small initramfs image or other images that do not
  3493. need the kernel, this can be set to "" in the image recipe.
  3494. :term:`KERNEL_DEVICETREE`
  3495. Specifies the name of the generated Linux kernel device tree (i.e.
  3496. the ``.dtb``) file.
  3497. .. note::
  3498. There is legacy support for specifying the full path to the device
  3499. tree. However, providing just the ``.dtb`` file is preferred.
  3500. In order to use this variable, the :ref:`ref-classes-kernel-devicetree`
  3501. class must be inherited.
  3502. :term:`KERNEL_DEVICETREE_BUNDLE`
  3503. When set to "1", this variable allows to bundle the Linux kernel
  3504. and the Device Tree Binary together in a single file.
  3505. This feature is currently only supported on the "arm" (32 bit)
  3506. architecture.
  3507. This variable is set to "0" by default by the
  3508. :ref:`ref-classes-kernel-devicetree` class.
  3509. :term:`KERNEL_DTB_LINK_NAME`
  3510. The link name of the kernel device tree binary (DTB). This variable
  3511. is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
  3512. follows::
  3513. KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3514. The
  3515. value of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in
  3516. the same file, has the following value::
  3517. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3518. See the :term:`MACHINE` variable for additional
  3519. information.
  3520. :term:`KERNEL_DTB_NAME`
  3521. The base name of the kernel device tree binary (DTB). This variable
  3522. is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
  3523. follows::
  3524. KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3525. See :term:`KERNEL_ARTIFACT_NAME` for additional information.
  3526. :term:`KERNEL_DTBDEST`
  3527. This variable, used by the :ref:`ref-classes-kernel-devicetree`
  3528. class, allows to change the installation directory of the DTB
  3529. (Device Tree Binary) files.
  3530. It is set by default to "${KERNEL_IMAGEDEST}" by the
  3531. :ref:`ref-classes-kernel` class.
  3532. :term:`KERNEL_DTBVENDORED`
  3533. This variable, used by the :ref:`ref-classes-kernel-devicetree`,
  3534. allows to ignore vendor subdirectories when installing DTB
  3535. (Device Tree Binary) files, when it is set to "false".
  3536. To keep vendor subdirectories, set this variable to "true".
  3537. It is set by default to "false" by the :ref:`ref-classes-kernel` class.
  3538. :term:`KERNEL_DTC_FLAGS`
  3539. Specifies the ``dtc`` flags that are passed to the Linux kernel build
  3540. system when generating the device trees (via ``DTC_FLAGS`` environment
  3541. variable).
  3542. In order to use this variable, the :ref:`ref-classes-kernel-devicetree`
  3543. class must be inherited.
  3544. :term:`KERNEL_EXTRA_ARGS`
  3545. Specifies additional ``make`` command-line arguments the OpenEmbedded
  3546. build system passes on when compiling the kernel.
  3547. :term:`KERNEL_FEATURES`
  3548. Includes additional kernel metadata. In the OpenEmbedded build
  3549. system, the default Board Support Packages (BSPs)
  3550. :term:`Metadata` is provided through the
  3551. :term:`KMACHINE` and :term:`KBRANCH`
  3552. variables. You can use the :term:`KERNEL_FEATURES` variable from within
  3553. the kernel recipe or kernel append file to further add metadata for
  3554. all BSPs or specific BSPs.
  3555. The metadata you add through this variable includes config fragments
  3556. and features descriptions, which usually includes patches as well as
  3557. config fragments. You typically override the :term:`KERNEL_FEATURES`
  3558. variable for a specific machine. In this way, you can provide
  3559. validated, but optional, sets of kernel configurations and features.
  3560. For example, the following example from the ``linux-yocto-rt_4.12``
  3561. kernel recipe adds "netfilter" and "taskstats" features to all BSPs
  3562. as well as "virtio" configurations to all QEMU machines. The last two
  3563. statements add specific configurations to targeted machine types::
  3564. KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
  3565. KERNEL_FEATURES:append = " ${KERNEL_EXTRA_FEATURES}"
  3566. KERNEL_FEATURES:append:qemuall = " cfg/virtio.scc"
  3567. KERNEL_FEATURES:append:qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
  3568. KERNEL_FEATURES:append:qemux86-64 = " cfg/sound.scc"
  3569. :term:`KERNEL_FIT_LINK_NAME`
  3570. The link name of the kernel flattened image tree (FIT) image. This
  3571. variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass``
  3572. file as follows::
  3573. KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3574. The value of the
  3575. ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
  3576. file, has the following value::
  3577. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3578. See the :term:`MACHINE` variable for additional
  3579. information.
  3580. :term:`KERNEL_FIT_NAME`
  3581. The base name of the kernel flattened image tree (FIT) image. This
  3582. variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass``
  3583. file as follows::
  3584. KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3585. See :term:`KERNEL_ARTIFACT_NAME` for additional information.
  3586. :term:`KERNEL_IMAGE_LINK_NAME`
  3587. The link name for the kernel image. This variable is set in the
  3588. ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
  3589. KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3590. The value of
  3591. the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
  3592. file, has the following value::
  3593. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3594. See the :term:`MACHINE` variable for additional
  3595. information.
  3596. :term:`KERNEL_IMAGE_MAXSIZE`
  3597. Specifies the maximum size of the kernel image file in kilobytes. If
  3598. :term:`KERNEL_IMAGE_MAXSIZE` is set, the size of the kernel image file is
  3599. checked against the set value during the
  3600. :ref:`ref-tasks-sizecheck` task. The task fails if
  3601. the kernel image file is larger than the setting.
  3602. :term:`KERNEL_IMAGE_MAXSIZE` is useful for target devices that have a
  3603. limited amount of space in which the kernel image must be stored.
  3604. By default, this variable is not set, which means the size of the
  3605. kernel image is not checked.
  3606. :term:`KERNEL_IMAGE_NAME`
  3607. The base name of the kernel image. This variable is set in the
  3608. ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
  3609. KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3610. See :term:`KERNEL_ARTIFACT_NAME` for additional information.
  3611. :term:`KERNEL_IMAGETYPE`
  3612. The type of kernel to build for a device, usually set by the machine
  3613. configuration files and defaults to "zImage". This variable is used
  3614. when building the kernel and is passed to ``make`` as the target to
  3615. build.
  3616. To build additional kernel image types, use :term:`KERNEL_IMAGETYPES`.
  3617. :term:`KERNEL_IMAGETYPES`
  3618. Lists additional types of kernel images to build for a device in addition
  3619. to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the
  3620. machine configuration files.
  3621. :term:`KERNEL_MODULE_AUTOLOAD`
  3622. Lists kernel modules that need to be auto-loaded during boot.
  3623. .. note::
  3624. This variable replaces the deprecated :term:`module_autoload`
  3625. variable.
  3626. You can use the :term:`KERNEL_MODULE_AUTOLOAD` variable anywhere that it
  3627. can be recognized by the kernel recipe or by an out-of-tree kernel
  3628. module recipe (e.g. a machine configuration file, a distribution
  3629. configuration file, an append file for the recipe, or the recipe
  3630. itself).
  3631. Specify it as follows::
  3632. KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3"
  3633. Including :term:`KERNEL_MODULE_AUTOLOAD` causes the OpenEmbedded build
  3634. system to populate the ``/etc/modules-load.d/modname.conf`` file with
  3635. the list of modules to be auto-loaded on boot. The modules appear
  3636. one-per-line in the file. Here is an example of the most common use
  3637. case::
  3638. KERNEL_MODULE_AUTOLOAD += "module_name"
  3639. For information on how to populate the ``modname.conf`` file with
  3640. ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable.
  3641. :term:`KERNEL_MODULE_PROBECONF`
  3642. Provides a list of modules for which the OpenEmbedded build system
  3643. expects to find ``module_conf_``\ modname values that specify
  3644. configuration for each of the modules. For information on how to
  3645. provide those module configurations, see the
  3646. :term:`module_conf_* <module_conf>` variable.
  3647. :term:`KERNEL_PACKAGE_NAME`
  3648. Specifies the base name of the kernel packages, such as "kernel"
  3649. in the kernel packages such as "kernel-modules", "kernel-image" and
  3650. "kernel-dbg".
  3651. The default value for this variable is set to "kernel" by the
  3652. :ref:`ref-classes-kernel` class.
  3653. :term:`KERNEL_PATH`
  3654. The location of the kernel sources. This variable is set to the value
  3655. of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`
  3656. class. For information on how this variable is used, see the
  3657. ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
  3658. section in the Yocto Project Linux Kernel Development Manual.
  3659. To help maximize compatibility with out-of-tree drivers used to build
  3660. modules, the OpenEmbedded build system also recognizes and uses the
  3661. :term:`KERNEL_SRC` variable, which is identical to
  3662. the :term:`KERNEL_PATH` variable. Both variables are common variables
  3663. used by external Makefiles to point to the kernel source directory.
  3664. :term:`KERNEL_SRC`
  3665. The location of the kernel sources. This variable is set to the value
  3666. of the :term:`STAGING_KERNEL_DIR` within the :ref:`ref-classes-module`
  3667. class. For information on how this variable is used, see the
  3668. ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
  3669. section in the Yocto Project Linux Kernel Development Manual.
  3670. To help maximize compatibility with out-of-tree drivers used to build
  3671. modules, the OpenEmbedded build system also recognizes and uses the
  3672. :term:`KERNEL_PATH` variable, which is identical
  3673. to the :term:`KERNEL_SRC` variable. Both variables are common variables
  3674. used by external Makefiles to point to the kernel source directory.
  3675. :term:`KERNEL_STRIP`
  3676. Allows to specific which ``strip`` command to use to strip the kernel
  3677. binary, typically either GNU binutils ``strip`` or ``llvm-strip``.
  3678. :term:`KERNEL_VERSION`
  3679. Specifies the version of the kernel as extracted from ``version.h``
  3680. or ``utsrelease.h`` within the kernel sources. Effects of setting
  3681. this variable do not take effect until the kernel has been
  3682. configured. Consequently, attempting to refer to this variable in
  3683. contexts prior to configuration will not work.
  3684. :term:`KERNELDEPMODDEPEND`
  3685. Specifies whether the data referenced through
  3686. :term:`PKGDATA_DIR` is needed or not.
  3687. :term:`KERNELDEPMODDEPEND` does not control whether or not that data
  3688. exists, but simply whether or not it is used. If you do not need to
  3689. use the data, set the :term:`KERNELDEPMODDEPEND` variable in your
  3690. :term:`Initramfs` recipe. Setting the variable there when the data is not
  3691. needed avoids a potential dependency loop.
  3692. :term:`KFEATURE_DESCRIPTION`
  3693. Provides a short description of a configuration fragment. You use
  3694. this variable in the ``.scc`` file that describes a configuration
  3695. fragment file. Here is the variable used in a file named ``smp.scc``
  3696. to describe SMP being enabled::
  3697. define KFEATURE_DESCRIPTION "Enable SMP"
  3698. :term:`KMACHINE`
  3699. The machine as known by the kernel. Sometimes the machine name used
  3700. by the kernel does not match the machine name used by the
  3701. OpenEmbedded build system. For example, the machine name that the
  3702. OpenEmbedded build system understands as ``core2-32-intel-common``
  3703. goes by a different name in the Linux Yocto kernel. The kernel
  3704. understands that machine as ``intel-core2-32``. For cases like these,
  3705. the :term:`KMACHINE` variable maps the kernel machine name to the
  3706. OpenEmbedded build system machine name.
  3707. These mappings between different names occur in the Yocto Linux
  3708. Kernel's ``meta`` branch. As an example take a look in the
  3709. ``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file::
  3710. LINUX_VERSION:core2-32-intel-common = "3.19.0"
  3711. COMPATIBLE_MACHINE:core2-32-intel-common = "${MACHINE}"
  3712. SRCREV_meta:core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974"
  3713. SRCREV_machine:core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
  3714. KMACHINE:core2-32-intel-common = "intel-core2-32"
  3715. KBRANCH:core2-32-intel-common = "standard/base"
  3716. KERNEL_FEATURES:append:core2-32-intel-common = " ${KERNEL_FEATURES_INTEL_COMMON}"
  3717. The :term:`KMACHINE` statement says
  3718. that the kernel understands the machine name as "intel-core2-32".
  3719. However, the OpenEmbedded build system understands the machine as
  3720. "core2-32-intel-common".
  3721. :term:`KTYPE`
  3722. Defines the kernel type to be used in assembling the configuration.
  3723. The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
  3724. kernel types. See the ":ref:`kernel-dev/advanced:kernel types`"
  3725. section in the
  3726. Yocto Project Linux Kernel Development Manual for more information on
  3727. kernel types.
  3728. You define the :term:`KTYPE` variable in the
  3729. :ref:`kernel-dev/advanced:bsp descriptions`. The
  3730. value you use must match the value used for the
  3731. :term:`LINUX_KERNEL_TYPE` value used by the
  3732. kernel recipe.
  3733. :term:`LABELS`
  3734. Provides a list of targets for automatic configuration.
  3735. See the :ref:`ref-classes-grub-efi` class for more
  3736. information on how this variable is used.
  3737. :term:`LAYERDEPENDS`
  3738. Lists the layers, separated by spaces, on which this recipe depends.
  3739. Optionally, you can specify a specific layer version for a dependency
  3740. by adding it to the end of the layer name. Here is an example::
  3741. LAYERDEPENDS_mylayer = "anotherlayer (=3)"
  3742. In this previous example,
  3743. version 3 of "anotherlayer" is compared against
  3744. :term:`LAYERVERSION`\ ``_anotherlayer``.
  3745. An error is produced if any dependency is missing or the version
  3746. numbers (if specified) do not match exactly. This variable is used in
  3747. the ``conf/layer.conf`` file and must be suffixed with the name of
  3748. the specific layer (e.g. ``LAYERDEPENDS_mylayer``).
  3749. :term:`LAYERDIR`
  3750. When used inside the ``layer.conf`` configuration file, this variable
  3751. provides the path of the current layer. This variable is not
  3752. available outside of ``layer.conf`` and references are expanded
  3753. immediately when parsing of the file completes.
  3754. :term:`LAYERDIR_RE`
  3755. See :term:`bitbake:LAYERDIR_RE` in the BitBake manual.
  3756. :term:`LAYERRECOMMENDS`
  3757. Lists the layers, separated by spaces, recommended for use with this
  3758. layer.
  3759. Optionally, you can specify a specific layer version for a
  3760. recommendation by adding the version to the end of the layer name.
  3761. Here is an example::
  3762. LAYERRECOMMENDS_mylayer = "anotherlayer (=3)"
  3763. In this previous example, version 3 of "anotherlayer" is compared
  3764. against ``LAYERVERSION_anotherlayer``.
  3765. This variable is used in the ``conf/layer.conf`` file and must be
  3766. suffixed with the name of the specific layer (e.g.
  3767. ``LAYERRECOMMENDS_mylayer``).
  3768. :term:`LAYERSERIES_COMPAT`
  3769. See :term:`bitbake:LAYERSERIES_COMPAT` in the BitBake manual.
  3770. :term:`LAYERVERSION`
  3771. Optionally specifies the version of a layer as a single number. You
  3772. can use this within :term:`LAYERDEPENDS` for
  3773. another layer in order to depend on a specific version of the layer.
  3774. This variable is used in the ``conf/layer.conf`` file and must be
  3775. suffixed with the name of the specific layer (e.g.
  3776. ``LAYERVERSION_mylayer``).
  3777. :term:`LD`
  3778. The minimal command and arguments used to run the linker.
  3779. :term:`LDFLAGS`
  3780. Specifies the flags to pass to the linker. This variable is exported
  3781. to an environment variable and thus made visible to the software
  3782. being built during the compilation step.
  3783. Default initialization for :term:`LDFLAGS` varies depending on what is
  3784. being built:
  3785. - :term:`TARGET_LDFLAGS` when building for the
  3786. target
  3787. - :term:`BUILD_LDFLAGS` when building for the
  3788. build host (i.e. ``-native``)
  3789. - :term:`BUILDSDK_LDFLAGS` when building for
  3790. an SDK (i.e. ``nativesdk-``)
  3791. :term:`LEAD_SONAME`
  3792. Specifies the lead (or primary) compiled library file (i.e. ``.so``)
  3793. that the :ref:`ref-classes-debian` class applies its
  3794. naming policy to given a recipe that packages multiple libraries.
  3795. This variable works in conjunction with the :ref:`ref-classes-debian`
  3796. class.
  3797. :term:`LIC_FILES_CHKSUM`
  3798. Checksums of the license text in the recipe source code.
  3799. This variable tracks changes in license text of the source code
  3800. files. If the license text is changed, it will trigger a build
  3801. failure, which gives the developer an opportunity to review any
  3802. license change.
  3803. This variable must be defined for all recipes (unless
  3804. :term:`LICENSE` is set to "CLOSED").
  3805. For more information, see the ":ref:`dev-manual/licenses:tracking license changes`"
  3806. section in the Yocto Project Development Tasks Manual.
  3807. :term:`LICENSE`
  3808. The list of source licenses for the recipe. Follow these rules:
  3809. - Do not use spaces within individual license names.
  3810. - Separate license names using \| (pipe) when there is a choice
  3811. between licenses.
  3812. - Separate license names using & (ampersand) when there are
  3813. multiple licenses for different parts of the source.
  3814. - You can use spaces between license names.
  3815. - For standard licenses, use the names of the files in
  3816. ``meta/files/common-licenses/`` or the
  3817. :term:`SPDXLICENSEMAP` flag names defined in
  3818. ``meta/conf/licenses.conf``.
  3819. Here are some examples::
  3820. LICENSE = "LGPL-2.1-only | GPL-3.0-only"
  3821. LICENSE = "MPL-1.0 & LGPL-2.1-only"
  3822. LICENSE = "GPL-2.0-or-later"
  3823. The first example is from the
  3824. recipes for Qt, which the user may choose to distribute under either
  3825. the LGPL version 2.1 or GPL version 3. The second example is from
  3826. Cairo where two licenses cover different parts of the source code.
  3827. The final example is from ``sysstat``, which presents a single
  3828. license.
  3829. You can also specify licenses on a per-package basis to handle
  3830. situations where components of the output have different licenses.
  3831. For example, a piece of software whose code is licensed under GPLv2
  3832. but has accompanying documentation licensed under the GNU Free
  3833. Documentation License 1.2 could be specified as follows::
  3834. LICENSE = "GFDL-1.2 & GPL-2.0-only"
  3835. LICENSE:${PN} = "GPL-2.0.only"
  3836. LICENSE:${PN}-doc = "GFDL-1.2"
  3837. :term:`LICENSE_CREATE_PACKAGE`
  3838. Setting :term:`LICENSE_CREATE_PACKAGE` to "1" causes the OpenEmbedded
  3839. build system to create an extra package (i.e.
  3840. ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add
  3841. those packages to the
  3842. :term:`RRECOMMENDS`\ ``:${PN}``.
  3843. The ``${PN}-lic`` package installs a directory in
  3844. ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base
  3845. name, and installs files in that directory that contain license and
  3846. copyright information (i.e. copies of the appropriate license files
  3847. from ``meta/common-licenses`` that match the licenses specified in
  3848. the :term:`LICENSE` variable of the recipe metadata
  3849. and copies of files marked in
  3850. :term:`LIC_FILES_CHKSUM` as containing
  3851. license text).
  3852. For related information on providing license text, see the
  3853. :term:`COPY_LIC_DIRS` variable, the
  3854. :term:`COPY_LIC_MANIFEST` variable, and the
  3855. ":ref:`dev-manual/licenses:providing license text`"
  3856. section in the Yocto Project Development Tasks Manual.
  3857. :term:`LICENSE_FLAGS`
  3858. Specifies additional flags for a recipe you must allow through
  3859. :term:`LICENSE_FLAGS_ACCEPTED` in
  3860. order for the recipe to be built. When providing multiple flags,
  3861. separate them with spaces.
  3862. This value is independent of :term:`LICENSE` and is
  3863. typically used to mark recipes that might require additional licenses
  3864. in order to be used in a commercial product. For more information,
  3865. see the
  3866. ":ref:`dev-manual/licenses:enabling commercially licensed recipes`"
  3867. section in the Yocto Project Development Tasks Manual.
  3868. :term:`LICENSE_FLAGS_ACCEPTED`
  3869. Lists license flags that when specified in
  3870. :term:`LICENSE_FLAGS` within a recipe should not
  3871. prevent that recipe from being built. For more information, see the
  3872. ":ref:`dev-manual/licenses:enabling commercially licensed recipes`"
  3873. section in the Yocto Project Development Tasks Manual.
  3874. :term:`LICENSE_FLAGS_DETAILS`
  3875. Adds details about a flag in :term:`LICENSE_FLAGS`. This way,
  3876. if such a flag is not accepted through :term:`LICENSE_FLAGS_ACCEPTED`,
  3877. the error message will be more informative, containing the specified
  3878. extra details.
  3879. For example, a recipe with an EULA may set::
  3880. LICENSE_FLAGS = "FooBar-EULA"
  3881. LICENSE_FLAGS_DETAILS[FooBar-EULA] = "For further details, see https://example.com/eula."
  3882. If ``Foobar-EULA`` isn't in :term:`LICENSE_FLAGS_ACCEPTED`, the
  3883. error message is more useful::
  3884. Has a restricted license 'FooBar-EULA' which is not listed in your LICENSE_FLAGS_ACCEPTED.
  3885. For further details, see https://example.com/eula.
  3886. :term:`LICENSE_PATH`
  3887. Path to additional licenses used during the build. By default, the
  3888. OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the
  3889. directory that holds common license text used during the build. The
  3890. :term:`LICENSE_PATH` variable allows you to extend that location to other
  3891. areas that have additional licenses::
  3892. LICENSE_PATH += "path-to-additional-common-licenses"
  3893. :term:`LINUX_KERNEL_TYPE`
  3894. Defines the kernel type to be used in assembling the configuration.
  3895. The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
  3896. kernel types. See the ":ref:`kernel-dev/advanced:kernel types`"
  3897. section in the
  3898. Yocto Project Linux Kernel Development Manual for more information on
  3899. kernel types.
  3900. If you do not specify a :term:`LINUX_KERNEL_TYPE`, it defaults to
  3901. "standard". Together with :term:`KMACHINE`, the
  3902. :term:`LINUX_KERNEL_TYPE` variable defines the search arguments used by
  3903. the kernel tools to find the appropriate description within the
  3904. kernel :term:`Metadata` with which to build out the sources
  3905. and configuration.
  3906. :term:`LINUX_VERSION`
  3907. The Linux version from ``kernel.org`` on which the Linux kernel image
  3908. being built using the OpenEmbedded build system is based. You define
  3909. this variable in the kernel recipe. For example, the
  3910. ``linux-yocto-3.4.bb`` kernel recipe found in
  3911. ``meta/recipes-kernel/linux`` defines the variables as follows::
  3912. LINUX_VERSION ?= "3.4.24"
  3913. The :term:`LINUX_VERSION` variable is used to define :term:`PV`
  3914. for the recipe::
  3915. PV = "${LINUX_VERSION}+git${SRCPV}"
  3916. :term:`LINUX_VERSION_EXTENSION`
  3917. A string extension compiled into the version string of the Linux
  3918. kernel built with the OpenEmbedded build system. You define this
  3919. variable in the kernel recipe. For example, the linux-yocto kernel
  3920. recipes all define the variable as follows::
  3921. LINUX_VERSION_EXTENSION ?= "-yocto-${LINUX_KERNEL_TYPE}"
  3922. Defining this variable essentially sets the Linux kernel
  3923. configuration item ``CONFIG_LOCALVERSION``, which is visible through
  3924. the ``uname`` command. Here is an example that shows the extension
  3925. assuming it was set as previously shown::
  3926. $ uname -r
  3927. 3.7.0-rc8-custom
  3928. :term:`LOG_DIR`
  3929. Specifies the directory to which the OpenEmbedded build system writes
  3930. overall log files. The default directory is ``${TMPDIR}/log``.
  3931. For the directory containing logs specific to each task, see the
  3932. :term:`T` variable.
  3933. :term:`MACHINE`
  3934. Specifies the target device for which the image is built. You define
  3935. :term:`MACHINE` in the ``local.conf`` file found in the
  3936. :term:`Build Directory`. By default, :term:`MACHINE` is set to
  3937. "qemux86", which is an x86-based architecture machine to be emulated
  3938. using QEMU::
  3939. MACHINE ?= "qemux86"
  3940. The variable corresponds to a machine configuration file of the same
  3941. name, through which machine-specific configurations are set. Thus,
  3942. when :term:`MACHINE` is set to "qemux86", the corresponding
  3943. ``qemux86.conf`` machine configuration file can be found in
  3944. the :term:`Source Directory` in
  3945. ``meta/conf/machine``.
  3946. The list of machines supported by the Yocto Project as shipped
  3947. include the following::
  3948. MACHINE ?= "qemuarm"
  3949. MACHINE ?= "qemuarm64"
  3950. MACHINE ?= "qemumips"
  3951. MACHINE ?= "qemumips64"
  3952. MACHINE ?= "qemuppc"
  3953. MACHINE ?= "qemux86"
  3954. MACHINE ?= "qemux86-64"
  3955. MACHINE ?= "genericx86"
  3956. MACHINE ?= "genericx86-64"
  3957. MACHINE ?= "beaglebone"
  3958. The last five are Yocto Project reference hardware
  3959. boards, which are provided in the ``meta-yocto-bsp`` layer.
  3960. .. note::
  3961. Adding additional Board Support Package (BSP) layers to your
  3962. configuration adds new possible settings for :term:`MACHINE`.
  3963. :term:`MACHINE_ARCH`
  3964. Specifies the name of the machine-specific architecture. This
  3965. variable is set automatically from :term:`MACHINE` or
  3966. :term:`TUNE_PKGARCH`. You should not hand-edit
  3967. the :term:`MACHINE_ARCH` variable.
  3968. :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
  3969. A list of required machine-specific packages to install as part of
  3970. the image being built. The build process depends on these packages
  3971. being present. Furthermore, because this is a "machine-essential"
  3972. variable, the list of packages are essential for the machine to boot.
  3973. The impact of this variable affects images based on
  3974. ``packagegroup-core-boot``, including the ``core-image-minimal``
  3975. image.
  3976. This variable is similar to the
  3977. :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` variable with the exception
  3978. that the image being built has a build dependency on the variable's
  3979. list of packages. In other words, the image will not build if a file
  3980. in this list is not found.
  3981. As an example, suppose the machine for which you are building
  3982. requires ``example-init`` to be run during boot to initialize the
  3983. hardware. In this case, you would use the following in the machine's
  3984. ``.conf`` configuration file::
  3985. MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init"
  3986. :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
  3987. A list of recommended machine-specific packages to install as part of
  3988. the image being built. The build process does not depend on these
  3989. packages being present. However, because this is a
  3990. "machine-essential" variable, the list of packages are essential for
  3991. the machine to boot. The impact of this variable affects images based
  3992. on ``packagegroup-core-boot``, including the ``core-image-minimal``
  3993. image.
  3994. This variable is similar to the :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
  3995. variable with the exception that the image being built does not have
  3996. a build dependency on the variable's list of packages. In other
  3997. words, the image will still build if a package in this list is not
  3998. found. Typically, this variable is used to handle essential kernel
  3999. modules, whose functionality may be selected to be built into the
  4000. kernel rather than as a module, in which case a package will not be
  4001. produced.
  4002. Consider an example where you have a custom kernel where a specific
  4003. touchscreen driver is required for the machine to be usable. However,
  4004. the driver can be built as a module or into the kernel depending on
  4005. the kernel configuration. If the driver is built as a module, you
  4006. want it to be installed. But, when the driver is built into the
  4007. kernel, you still want the build to succeed. This variable sets up a
  4008. "recommends" relationship so that in the latter case, the build will
  4009. not fail due to the missing package. To accomplish this, assuming the
  4010. package for the module was called ``kernel-module-ab123``, you would
  4011. use the following in the machine's ``.conf`` configuration file::
  4012. MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123"
  4013. .. note::
  4014. In this example, the ``kernel-module-ab123`` recipe needs to
  4015. explicitly set its :term:`PACKAGES` variable to ensure that BitBake
  4016. does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to
  4017. satisfy the dependency.
  4018. Some examples of these machine essentials are flash, screen,
  4019. keyboard, mouse, or touchscreen drivers (depending on the machine).
  4020. :term:`MACHINE_EXTRA_RDEPENDS`
  4021. A list of machine-specific packages to install as part of the image
  4022. being built that are not essential for the machine to boot. However,
  4023. the build process for more fully-featured images depends on the
  4024. packages being present.
  4025. This variable affects all images based on ``packagegroup-base``,
  4026. which does not include the ``core-image-minimal`` or
  4027. ``core-image-full-cmdline`` images.
  4028. The variable is similar to the :term:`MACHINE_EXTRA_RRECOMMENDS` variable
  4029. with the exception that the image being built has a build dependency
  4030. on the variable's list of packages. In other words, the image will
  4031. not build if a file in this list is not found.
  4032. An example is a machine that has WiFi capability but is not essential
  4033. for the machine to boot the image. However, if you are building a
  4034. more fully-featured image, you want to enable the WiFi. The package
  4035. containing the firmware for the WiFi hardware is always expected to
  4036. exist, so it is acceptable for the build process to depend upon
  4037. finding the package. In this case, assuming the package for the
  4038. firmware was called ``wifidriver-firmware``, you would use the
  4039. following in the ``.conf`` file for the machine::
  4040. MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware"
  4041. :term:`MACHINE_EXTRA_RRECOMMENDS`
  4042. A list of machine-specific packages to install as part of the image
  4043. being built that are not essential for booting the machine. The image
  4044. being built has no build dependency on this list of packages.
  4045. This variable affects only images based on ``packagegroup-base``,
  4046. which does not include the ``core-image-minimal`` or
  4047. ``core-image-full-cmdline`` images.
  4048. This variable is similar to the :term:`MACHINE_EXTRA_RDEPENDS` variable
  4049. with the exception that the image being built does not have a build
  4050. dependency on the variable's list of packages. In other words, the
  4051. image will build if a file in this list is not found.
  4052. An example is a machine that has WiFi capability but is not essential
  4053. For the machine to boot the image. However, if you are building a
  4054. more fully-featured image, you want to enable WiFi. In this case, the
  4055. package containing the WiFi kernel module will not be produced if the
  4056. WiFi driver is built into the kernel, in which case you still want
  4057. the build to succeed instead of failing as a result of the package
  4058. not being found. To accomplish this, assuming the package for the
  4059. module was called ``kernel-module-examplewifi``, you would use the
  4060. following in the ``.conf`` file for the machine::
  4061. MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi"
  4062. :term:`MACHINE_FEATURES`
  4063. Specifies the list of hardware features the
  4064. :term:`MACHINE` is capable of supporting. For related
  4065. information on enabling features, see the
  4066. :term:`DISTRO_FEATURES`,
  4067. :term:`COMBINED_FEATURES`, and
  4068. :term:`IMAGE_FEATURES` variables.
  4069. For a list of hardware features supported by the Yocto Project as
  4070. shipped, see the ":ref:`ref-features-machine`" section.
  4071. :term:`MACHINE_FEATURES_BACKFILL`
  4072. A list of space-separated features to be added to
  4073. :term:`MACHINE_FEATURES` if not also present in
  4074. :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
  4075. This variable is set in the ``meta/conf/bitbake.conf`` file. It is not
  4076. intended to be user-configurable. It is best to just reference the
  4077. variable to see which machine features are being
  4078. :ref:`backfilled <ref-features-backfill>` for all machine configurations.
  4079. :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
  4080. A list of space-separated features from :term:`MACHINE_FEATURES_BACKFILL`
  4081. that should not be :ref:`backfilled <ref-features-backfill>` (i.e. added
  4082. to :term:`MACHINE_FEATURES`) during the build.
  4083. This corresponds to an opt-out mechanism. When new default machine
  4084. features are introduced, machine definition maintainers can review
  4085. (`consider`) them and decide to exclude them from the
  4086. :ref:`backfilled <ref-features-backfill>` features. Therefore, the
  4087. combination of :term:`MACHINE_FEATURES_BACKFILL` and
  4088. :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` makes it possible to
  4089. add new default features without breaking existing machine definitions.
  4090. :term:`MACHINEOVERRIDES`
  4091. A colon-separated list of overrides that apply to the current
  4092. machine. By default, this list includes the value of
  4093. :term:`MACHINE`.
  4094. You can extend :term:`MACHINEOVERRIDES` to add extra overrides that
  4095. should apply to a machine. For example, all machines emulated in QEMU
  4096. (e.g. ``qemuarm``, ``qemux86``, and so forth) include a file named
  4097. ``meta/conf/machine/include/qemu.inc`` that prepends the following
  4098. override to :term:`MACHINEOVERRIDES`::
  4099. MACHINEOVERRIDES =. "qemuall:"
  4100. This
  4101. override allows variables to be overridden for all machines emulated
  4102. in QEMU, like in the following example from the ``connman-conf``
  4103. recipe::
  4104. SRC_URI:append:qemuall = " file://wired.config \
  4105. file://wired-setup \
  4106. "
  4107. The underlying mechanism behind
  4108. :term:`MACHINEOVERRIDES` is simply that it is included in the default
  4109. value of :term:`OVERRIDES`.
  4110. :term:`MAINTAINER`
  4111. The email address of the distribution maintainer.
  4112. :term:`MESON_BUILDTYPE`
  4113. Value of the Meson ``--buildtype`` argument used by the
  4114. :ref:`ref-classes-meson` class. It defaults to ``debug`` if
  4115. :term:`DEBUG_BUILD` is set to "1", and ``plain`` otherwise.
  4116. See `Meson build options <https://mesonbuild.com/Builtin-options.html>`__
  4117. for the values you could set in a recipe. Values such as ``plain``,
  4118. ``debug``, ``debugoptimized``, ``release`` and ``minsize`` allow
  4119. you to specify the inclusion of debugging symbols and the compiler
  4120. optimizations (none, performance or size).
  4121. :term:`MESON_TARGET`
  4122. A variable for the :ref:`ref-classes-meson` class, allowing to choose
  4123. a Meson target to build in :ref:`ref-tasks-compile`. Otherwise, the
  4124. default targets are built.
  4125. :term:`METADATA_BRANCH`
  4126. The branch currently checked out for the OpenEmbedded-Core layer (path
  4127. determined by :term:`COREBASE`).
  4128. :term:`METADATA_REVISION`
  4129. The revision currently checked out for the OpenEmbedded-Core layer (path
  4130. determined by :term:`COREBASE`).
  4131. :term:`MIME_XDG_PACKAGES`
  4132. The current implementation of the :ref:`ref-classes-mime-xdg`
  4133. class cannot detect ``.desktop`` files installed through absolute
  4134. symbolic links. Use this setting to make the class create post-install
  4135. and post-remove scripts for these packages anyway, to invoke the
  4136. ``update-destop-database`` command.
  4137. :term:`MIRRORS`
  4138. Specifies additional paths from which the OpenEmbedded build system
  4139. gets source code. When the build system searches for source code, it
  4140. first tries the local download directory. If that location fails, the
  4141. build system tries locations defined by
  4142. :term:`PREMIRRORS`, the upstream source, and then
  4143. locations specified by :term:`MIRRORS` in that order.
  4144. The default value for :term:`MIRRORS` is defined in the
  4145. ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer.
  4146. :term:`MLPREFIX`
  4147. Specifies a prefix has been added to :term:`PN` to create a
  4148. special version of a recipe or package (i.e. a Multilib version). The
  4149. variable is used in places where the prefix needs to be added to or
  4150. removed from a name (e.g. the :term:`BPN` variable).
  4151. :term:`MLPREFIX` gets set when a prefix has been added to :term:`PN`.
  4152. .. note::
  4153. The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation
  4154. is historical and comes from a time when ":ref:`ref-classes-nativesdk`"
  4155. was a suffix rather than a prefix on the recipe name. When
  4156. ":ref:`ref-classes-nativesdk`" was turned into a prefix, it made sense
  4157. to set :term:`MLPREFIX` for it as well.
  4158. To help understand when :term:`MLPREFIX` might be needed, consider when
  4159. :term:`BBCLASSEXTEND` is used to provide a :ref:`ref-classes-nativesdk`
  4160. version of a recipe in addition to the target version. If that recipe
  4161. declares build-time dependencies on tasks in other recipes by using
  4162. :term:`DEPENDS`, then a dependency on "foo" will automatically get
  4163. rewritten to a dependency on "nativesdk-foo". However, dependencies like
  4164. the following will not get rewritten automatically::
  4165. do_foo[depends] += "recipe:do_foo"
  4166. If you want such a dependency to also get transformed, you can do the
  4167. following::
  4168. do_foo[depends] += "${MLPREFIX}recipe:do_foo"
  4169. :term:`module_autoload`
  4170. This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD`
  4171. variable. You should replace all occurrences of :term:`module_autoload`
  4172. with additions to :term:`KERNEL_MODULE_AUTOLOAD`, for example::
  4173. module_autoload_rfcomm = "rfcomm"
  4174. should now be replaced with::
  4175. KERNEL_MODULE_AUTOLOAD += "rfcomm"
  4176. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information.
  4177. :term:`module_conf`
  4178. Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`__
  4179. syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
  4180. file.
  4181. You can use this variable anywhere that it can be recognized by the
  4182. kernel recipe or out-of-tree kernel module recipe (e.g. a machine
  4183. configuration file, a distribution configuration file, an append file
  4184. for the recipe, or the recipe itself). If you use this variable, you
  4185. must also be sure to list the module name in the
  4186. :term:`KERNEL_MODULE_PROBECONF`
  4187. variable.
  4188. Here is the general syntax::
  4189. module_conf_module_name = "modprobe.d-syntax"
  4190. You must use the kernel module name override.
  4191. Run ``man modprobe.d`` in the shell to find out more information on
  4192. the exact syntax you want to provide with :term:`module_conf`.
  4193. Including :term:`module_conf` causes the OpenEmbedded build system to
  4194. populate the ``/etc/modprobe.d/modname.conf`` file with
  4195. ``modprobe.d`` syntax lines. Here is an example that adds the options
  4196. ``arg1`` and ``arg2`` to a module named ``mymodule``::
  4197. module_conf_mymodule = "options mymodule arg1=val1 arg2=val2"
  4198. For information on how to specify kernel modules to auto-load on
  4199. boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable.
  4200. :term:`MODULE_TARBALL_DEPLOY`
  4201. Controls creation of the ``modules-*.tgz`` file. Set this variable to
  4202. "0" to disable creation of this file, which contains all of the
  4203. kernel modules resulting from a kernel build.
  4204. :term:`MODULE_TARBALL_LINK_NAME`
  4205. The link name of the kernel module tarball. This variable is set in
  4206. the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
  4207. MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  4208. The value
  4209. of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the
  4210. same file, has the following value::
  4211. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  4212. See the :term:`MACHINE` variable for additional information.
  4213. :term:`MODULE_TARBALL_NAME`
  4214. The base name of the kernel module tarball. This variable is set in
  4215. the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
  4216. MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  4217. See :term:`KERNEL_ARTIFACT_NAME` for additional information.
  4218. :term:`MOUNT_BASE`
  4219. On non-systemd systems (where ``udev-extraconf`` is being used),
  4220. specifies the base directory for auto-mounting filesystems. The
  4221. default value is "/run/media".
  4222. :term:`MULTIMACH_TARGET_SYS`
  4223. Uniquely identifies the type of the target system for which packages
  4224. are being built. This variable allows output for different types of
  4225. target systems to be put into different subdirectories of the same
  4226. output directory.
  4227. The default value of this variable is::
  4228. ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}
  4229. Some classes (e.g. :ref:`ref-classes-cross-canadian`) modify the
  4230. :term:`MULTIMACH_TARGET_SYS` value.
  4231. See the :term:`STAMP` variable for an example. See the
  4232. :term:`STAGING_DIR_TARGET` variable for more information.
  4233. :term:`NATIVELSBSTRING`
  4234. A string identifying the host distribution. Strings consist of the
  4235. host distributor ID followed by the release, as reported by the
  4236. ``lsb_release`` tool or as read from ``/etc/lsb-release``. For
  4237. example, when running a build on Ubuntu 12.10, the value is
  4238. "Ubuntu-12.10". If this information is unable to be determined, the
  4239. value resolves to "Unknown".
  4240. This variable is used by default to isolate native shared state
  4241. packages for different distributions (e.g. to avoid problems with
  4242. ``glibc`` version incompatibilities). Additionally, the variable is
  4243. checked against
  4244. :term:`SANITY_TESTED_DISTROS` if that
  4245. variable is set.
  4246. :term:`NM`
  4247. The minimal command and arguments to run ``nm``.
  4248. :term:`NO_GENERIC_LICENSE`
  4249. Avoids QA errors when you use a non-common, non-CLOSED license in a
  4250. recipe. There are packages, such as the linux-firmware package, with many
  4251. licenses that are not in any way common. Also, new licenses are added
  4252. occasionally to avoid introducing a lot of common license files,
  4253. which are only applicable to a specific package.
  4254. :term:`NO_GENERIC_LICENSE` is used to allow copying a license that does
  4255. not exist in common licenses.
  4256. The following example shows how to add :term:`NO_GENERIC_LICENSE` to a
  4257. recipe::
  4258. NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source"
  4259. Here is an example that
  4260. uses the ``LICENSE.Abilis.txt`` file as the license from the fetched
  4261. source::
  4262. NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt"
  4263. :term:`NO_RECOMMENDATIONS`
  4264. Prevents installation of all "recommended-only" packages.
  4265. Recommended-only packages are packages installed only through the
  4266. :term:`RRECOMMENDS` variable). Setting the
  4267. :term:`NO_RECOMMENDATIONS` variable to "1" turns this feature on::
  4268. NO_RECOMMENDATIONS = "1"
  4269. You can set this variable globally in your ``local.conf`` file or you
  4270. can attach it to a specific image recipe by using the recipe name
  4271. override::
  4272. NO_RECOMMENDATIONS:pn-target_image = "1"
  4273. It is important to realize that if you choose to not install packages
  4274. using this variable and some other packages are dependent on them
  4275. (i.e. listed in a recipe's :term:`RDEPENDS`
  4276. variable), the OpenEmbedded build system ignores your request and
  4277. will install the packages to avoid dependency errors.
  4278. .. note::
  4279. Some recommended packages might be required for certain system
  4280. functionality, such as kernel modules. It is up to you to add
  4281. packages with the :term:`IMAGE_INSTALL` variable.
  4282. This variable is only supported when using the IPK and RPM
  4283. packaging backends. DEB is not supported.
  4284. See the :term:`BAD_RECOMMENDATIONS` and
  4285. the :term:`PACKAGE_EXCLUDE` variables for
  4286. related information.
  4287. :term:`NOAUTOPACKAGEDEBUG`
  4288. Disables auto package from splitting ``.debug`` files. If a recipe
  4289. requires ``FILES:${PN}-dbg`` to be set manually, the
  4290. :term:`NOAUTOPACKAGEDEBUG` can be defined allowing you to define the
  4291. content of the debug package. For example::
  4292. NOAUTOPACKAGEDEBUG = "1"
  4293. FILES:${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*"
  4294. FILES:${PN}-dbg = "/usr/src/debug/"
  4295. FILES:${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch"
  4296. :term:`NON_MULTILIB_RECIPES`
  4297. A list of recipes that should not be built for multilib. OE-Core's
  4298. ``multilib.conf`` file defines a reasonable starting point for this
  4299. list with::
  4300. NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot"
  4301. :term:`OBJCOPY`
  4302. The minimal command and arguments to run ``objcopy``.
  4303. :term:`OBJDUMP`
  4304. The minimal command and arguments to run ``objdump``.
  4305. :term:`OE_BINCONFIG_EXTRA_MANGLE`
  4306. When inheriting the :ref:`ref-classes-binconfig` class,
  4307. this variable specifies additional arguments passed to the "sed"
  4308. command. The sed command alters any paths in configuration scripts
  4309. that have been set up during compilation. Inheriting this class
  4310. results in all paths in these scripts being changed to point into the
  4311. ``sysroots/`` directory so that all builds that use the script will
  4312. use the correct directories for the cross compiling layout.
  4313. See the ``meta/classes-recipe/binconfig.bbclass`` in the
  4314. :term:`Source Directory` for details on how this class
  4315. applies these additional sed command arguments.
  4316. :term:`OECMAKE_GENERATOR`
  4317. A variable for the :ref:`ref-classes-cmake` class, allowing to choose
  4318. which back-end will be generated by CMake to build an application.
  4319. By default, this variable is set to ``Ninja``, which is faster than GNU
  4320. make, but if building is broken with Ninja, a recipe can use this
  4321. variable to use GNU make instead::
  4322. OECMAKE_GENERATOR = "Unix Makefiles"
  4323. :term:`OE_IMPORTS`
  4324. An internal variable used to tell the OpenEmbedded build system what
  4325. Python modules to import for every Python function run by the system.
  4326. .. note::
  4327. Do not set this variable. It is for internal use only.
  4328. :term:`OE_INIT_ENV_SCRIPT`
  4329. The name of the build environment setup script for the purposes of
  4330. setting up the environment within the extensible SDK. The default
  4331. value is "oe-init-build-env".
  4332. If you use a custom script to set up your build environment, set the
  4333. :term:`OE_INIT_ENV_SCRIPT` variable to its name.
  4334. :term:`OE_TERMINAL`
  4335. Controls how the OpenEmbedded build system spawns interactive
  4336. terminals on the host development system (e.g. using the BitBake
  4337. command with the ``-c devshell`` command-line option). For more
  4338. information, see the ":ref:`dev-manual/development-shell:using a development shell`" section in
  4339. the Yocto Project Development Tasks Manual.
  4340. You can use the following values for the :term:`OE_TERMINAL` variable:
  4341. - auto
  4342. - gnome
  4343. - xfce
  4344. - rxvt
  4345. - screen
  4346. - konsole
  4347. - none
  4348. :term:`OEROOT`
  4349. The directory from which the top-level build environment setup script
  4350. is sourced. The Yocto Project provides a top-level build environment
  4351. setup script: :ref:`structure-core-script`. When you run this
  4352. script, the :term:`OEROOT` variable resolves to the directory that
  4353. contains the script.
  4354. For additional information on how this variable is used, see the
  4355. initialization script.
  4356. :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE`
  4357. Set the package manager(s) for build reproducibility testing.
  4358. See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>`
  4359. and :doc:`/test-manual/reproducible-builds`.
  4360. :term:`OEQA_REPRODUCIBLE_TEST_TARGET`
  4361. Set build target for build reproducibility testing. By default
  4362. all available recipes are compiled with "bitbake world", see also :term:`EXCLUDE_FROM_WORLD`
  4363. and :doc:`/test-manual/reproducible-builds`.
  4364. :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS`
  4365. Set build targets which can be rebuilt using :ref:`shared state <overview-manual/concepts:shared state cache>`
  4366. when running build reproducibility tests. See :doc:`/test-manual/reproducible-builds`.
  4367. :term:`OLDEST_KERNEL`
  4368. Declares the oldest version of the Linux kernel that the produced
  4369. binaries must support. This variable is passed into the build of the
  4370. Embedded GNU C Library (``glibc``).
  4371. The default for this variable comes from the
  4372. ``meta/conf/bitbake.conf`` configuration file. You can override this
  4373. default by setting the variable in a custom distribution
  4374. configuration file.
  4375. :term:`OVERLAYFS_ETC_DEVICE`
  4376. When the :ref:`ref-classes-overlayfs-etc` class is
  4377. inherited, specifies the device to be mounted for the read/write
  4378. layer of ``/etc``. There is no default, so you must set this if you
  4379. wish to enable :ref:`ref-classes-overlayfs-etc`, for
  4380. example, assuming ``/dev/mmcblk0p2`` was the desired device::
  4381. OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2"
  4382. :term:`OVERLAYFS_ETC_EXPOSE_LOWER`
  4383. When the :ref:`ref-classes-overlayfs-etc` class is
  4384. inherited, if set to "1" then a read-only access to the original
  4385. ``/etc`` content will be provided as a ``lower/`` subdirectory of
  4386. :term:`OVERLAYFS_ETC_MOUNT_POINT`. The default value is "0".
  4387. :term:`OVERLAYFS_ETC_FSTYPE`
  4388. When the :ref:`ref-classes-overlayfs-etc` class is
  4389. inherited, specifies the file system type for the read/write
  4390. layer of ``/etc``. There is no default, so you must set this if you
  4391. wish to enable :ref:`ref-classes-overlayfs-etc`,
  4392. for example, assuming the file system is ext4::
  4393. OVERLAYFS_ETC_FSTYPE = "ext4"
  4394. :term:`OVERLAYFS_ETC_MOUNT_OPTIONS`
  4395. When the :ref:`ref-classes-overlayfs-etc` class is
  4396. inherited, specifies the mount options for the read-write layer.
  4397. The default value is "defaults".
  4398. :term:`OVERLAYFS_ETC_MOUNT_POINT`
  4399. When the :ref:`ref-classes-overlayfs-etc` class is
  4400. inherited, specifies the parent mount path for the filesystem layers.
  4401. There is no default, so you must set this if you wish to enable
  4402. :ref:`ref-classes-overlayfs-etc`, for example if the desired path is
  4403. "/data"::
  4404. OVERLAYFS_ETC_MOUNT_POINT = "/data"
  4405. :term:`OVERLAYFS_ETC_USE_ORIG_INIT_NAME`
  4406. When the :ref:`ref-classes-overlayfs-etc` class is inherited, controls
  4407. how the generated init will be named. For more information, see the
  4408. :ref:`ref-classes-overlayfs-etc` class documentation. The default value
  4409. is "1".
  4410. :term:`OVERLAYFS_MOUNT_POINT`
  4411. When inheriting the :ref:`ref-classes-overlayfs` class,
  4412. specifies mount point(s) to be used. For example::
  4413. OVERLAYFS_MOUNT_POINT[data] = "/data"
  4414. The assumes you have a ``data.mount`` systemd unit defined elsewhere in
  4415. your BSP (e.g. in ``systemd-machine-units`` recipe) and it is installed
  4416. into the image. For more information see :ref:`ref-classes-overlayfs`.
  4417. .. note::
  4418. Although the :ref:`ref-classes-overlayfs` class is
  4419. inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT`
  4420. should be set in your machine configuration.
  4421. :term:`OVERLAYFS_QA_SKIP`
  4422. When inheriting the :ref:`ref-classes-overlayfs` class,
  4423. provides the ability to disable QA checks for particular overlayfs
  4424. mounts. For example::
  4425. OVERLAYFS_QA_SKIP[data] = "mount-configured"
  4426. .. note::
  4427. Although the :ref:`ref-classes-overlayfs` class is
  4428. inherited by individual recipes, :term:`OVERLAYFS_QA_SKIP`
  4429. should be set in your machine configuration.
  4430. :term:`OVERLAYFS_WRITABLE_PATHS`
  4431. When inheriting the :ref:`ref-classes-overlayfs` class,
  4432. specifies writable paths used at runtime for the recipe. For
  4433. example::
  4434. OVERLAYFS_WRITABLE_PATHS[data] = "/usr/share/my-custom-application"
  4435. :term:`OVERRIDES`
  4436. A colon-separated list of overrides that currently apply. Overrides
  4437. are a BitBake mechanism that allows variables to be selectively
  4438. overridden at the end of parsing. The set of overrides in
  4439. :term:`OVERRIDES` represents the "state" during building, which includes
  4440. the current recipe being built, the machine for which it is being
  4441. built, and so forth.
  4442. As an example, if the string "an-override" appears as an element in
  4443. the colon-separated list in :term:`OVERRIDES`, then the following
  4444. assignment will override ``FOO`` with the value "overridden" at the
  4445. end of parsing::
  4446. FOO:an-override = "overridden"
  4447. See the
  4448. ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
  4449. section in the BitBake User Manual for more information on the
  4450. overrides mechanism.
  4451. The default value of :term:`OVERRIDES` includes the values of the
  4452. :term:`CLASSOVERRIDE`,
  4453. :term:`MACHINEOVERRIDES`, and
  4454. :term:`DISTROOVERRIDES` variables. Another
  4455. important override included by default is ``pn-${PN}``. This override
  4456. allows variables to be set for a single recipe within configuration
  4457. (``.conf``) files. Here is an example::
  4458. FOO:pn-myrecipe = "myrecipe-specific value"
  4459. .. note::
  4460. An easy way to see what overrides apply is to search for :term:`OVERRIDES`
  4461. in the output of the ``bitbake -e`` command. See the
  4462. ":ref:`dev-manual/debugging:viewing variable values`" section in the Yocto
  4463. Project Development Tasks Manual for more information.
  4464. :term:`P`
  4465. The recipe name and version. :term:`P` is comprised of the following::
  4466. ${PN}-${PV}
  4467. :term:`P4DIR`
  4468. See :term:`bitbake:P4DIR` in the BitBake manual.
  4469. :term:`PACKAGE_ADD_METADATA`
  4470. This variable defines additional metadata to add to packages.
  4471. You may find you need to inject additional metadata into packages.
  4472. This variable allows you to do that by setting the injected data as
  4473. the value. Multiple fields can be added by splitting the content with
  4474. the literal separator "\n".
  4475. The suffixes '_IPK', '_DEB', or '_RPM' can be applied to the variable
  4476. to do package type specific settings. It can also be made package
  4477. specific by using the package name as a suffix.
  4478. You can find out more about applying this variable in the
  4479. ":ref:`dev-manual/packages:adding custom metadata to packages`"
  4480. section in the Yocto Project Development Tasks Manual.
  4481. :term:`PACKAGE_ARCH`
  4482. The architecture of the resulting package or packages.
  4483. By default, the value of this variable is set to
  4484. :term:`TUNE_PKGARCH` when building for the
  4485. target, :term:`BUILD_ARCH` when building for the
  4486. build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the
  4487. SDK.
  4488. .. note::
  4489. See :term:`SDK_ARCH` for more information.
  4490. However, if your recipe's output packages are built specific to the
  4491. target machine rather than generally for the architecture of the
  4492. machine, you should set :term:`PACKAGE_ARCH` to the value of
  4493. :term:`MACHINE_ARCH` in the recipe as follows::
  4494. PACKAGE_ARCH = "${MACHINE_ARCH}"
  4495. :term:`PACKAGE_ARCHS`
  4496. Specifies a list of architectures compatible with the target machine.
  4497. This variable is set automatically and should not normally be
  4498. hand-edited. Entries are separated using spaces and listed in order
  4499. of priority. The default value for :term:`PACKAGE_ARCHS` is "all any
  4500. noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}".
  4501. :term:`PACKAGE_BEFORE_PN`
  4502. Enables easily adding packages to :term:`PACKAGES` before ``${PN}`` so
  4503. that those added packages can pick up files that would normally be
  4504. included in the default package.
  4505. :term:`PACKAGE_CLASSES`
  4506. This variable, which is set in the ``local.conf`` configuration file
  4507. found in the ``conf`` folder of the
  4508. :term:`Build Directory`, specifies the package manager the
  4509. OpenEmbedded build system uses when packaging data.
  4510. You can provide one or more of the following arguments for the
  4511. variable::
  4512. PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
  4513. The build system uses only the first argument in the list as the
  4514. package manager when creating your image or SDK. However, packages
  4515. will be created using any additional packaging classes you specify.
  4516. For example, if you use the following in your ``local.conf`` file::
  4517. PACKAGE_CLASSES ?= "package_ipk"
  4518. The OpenEmbedded build system uses
  4519. the IPK package manager to create your image or SDK.
  4520. For information on packaging and build performance effects as a
  4521. result of the package manager in use, see the
  4522. ":ref:`ref-classes-package`" section.
  4523. :term:`PACKAGE_DEBUG_SPLIT_STYLE`
  4524. Determines how to split up and package debug and source information
  4525. when creating debugging packages to be used with the GNU Project
  4526. Debugger (GDB). In general, based on the value of this variable,
  4527. you can combine the source and debug info in a single package,
  4528. you can break out the source into a separate package that can be
  4529. installed independently, or you can choose to not have the source
  4530. packaged at all.
  4531. The possible values of :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable:
  4532. - "``.debug``": All debugging and source info is placed in a single
  4533. ``*-dbg`` package; debug symbol files are placed next to the
  4534. binary in a ``.debug`` directory so that, if a binary is installed
  4535. into ``/bin``, the corresponding debug symbol file is installed
  4536. in ``/bin/.debug``. Source files are installed in the same ``*-dbg``
  4537. package under ``/usr/src/debug``.
  4538. - "``debug-file-directory``": As above, all debugging and source info
  4539. is placed in a single ``*-dbg`` package; debug symbol files are
  4540. placed entirely under the directory ``/usr/lib/debug`` and separated
  4541. by the path from where the binary is installed, so that if a binary
  4542. is installed in ``/bin``, the corresponding debug symbols are installed
  4543. in ``/usr/lib/debug/bin``, and so on. As above, source is installed
  4544. in the same package under ``/usr/src/debug``.
  4545. - "``debug-with-srcpkg``": Debugging info is placed in the standard
  4546. ``*-dbg`` package as with the ``.debug`` value, while source is
  4547. placed in a separate ``*-src`` package, which can be installed
  4548. independently. This is the default setting for this variable,
  4549. as defined in Poky's ``bitbake.conf`` file.
  4550. - "``debug-without-src``": The same behavior as with the ``.debug``
  4551. setting, but no source is packaged at all.
  4552. .. note::
  4553. Much of the above package splitting can be overridden via
  4554. use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable.
  4555. You can find out more about debugging using GDB by reading the
  4556. ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section
  4557. in the Yocto Project Development Tasks Manual.
  4558. :term:`PACKAGE_EXCLUDE`
  4559. Lists packages that should not be installed into an image. For
  4560. example::
  4561. PACKAGE_EXCLUDE = "package_name package_name package_name ..."
  4562. You can set this variable globally in your ``local.conf`` file or you
  4563. can attach it to a specific image recipe by using the recipe name
  4564. override::
  4565. PACKAGE_EXCLUDE:pn-target_image = "package_name"
  4566. If you choose to not install a package using this variable and some
  4567. other package is dependent on it (i.e. listed in a recipe's
  4568. :term:`RDEPENDS` variable), the OpenEmbedded build
  4569. system generates a fatal installation error. Because the build system
  4570. halts the process with a fatal error, you can use the variable with
  4571. an iterative development process to remove specific components from a
  4572. system.
  4573. This variable is supported only when using the IPK and RPM
  4574. packaging backends. DEB is not supported.
  4575. See the :term:`NO_RECOMMENDATIONS` and the
  4576. :term:`BAD_RECOMMENDATIONS` variables for
  4577. related information.
  4578. :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
  4579. Prevents specific packages from being installed when you are
  4580. installing complementary packages.
  4581. You might find that you want to prevent installing certain packages
  4582. when you are installing complementary packages. For example, if you
  4583. are using :term:`IMAGE_FEATURES` to install
  4584. ``dev-pkgs``, you might not want to install all packages from a
  4585. particular multilib. If you find yourself in this situation, you can
  4586. use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular
  4587. expressions to match the packages you want to exclude.
  4588. :term:`PACKAGE_EXTRA_ARCHS`
  4589. Specifies the list of architectures compatible with the device CPU.
  4590. This variable is useful when you build for several different devices
  4591. that use miscellaneous processors such as XScale and ARM926-EJS.
  4592. :term:`PACKAGE_FEED_ARCHS`
  4593. Optionally specifies the package architectures used as part of the
  4594. package feed URIs during the build. When used, the
  4595. :term:`PACKAGE_FEED_ARCHS` variable is appended to the final package feed
  4596. URI, which is constructed using the
  4597. :term:`PACKAGE_FEED_URIS` and
  4598. :term:`PACKAGE_FEED_BASE_PATHS`
  4599. variables.
  4600. .. note::
  4601. You can use the :term:`PACKAGE_FEED_ARCHS`
  4602. variable to allow specific package architectures. If you do
  4603. not need to allow specific architectures, which is a common
  4604. case, you can omit this variable. Omitting the variable results in
  4605. all available architectures for the current machine being included
  4606. into remote package feeds.
  4607. Consider the following example where the :term:`PACKAGE_FEED_URIS`,
  4608. :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables are
  4609. defined in your ``local.conf`` file::
  4610. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  4611. https://example.com/packagerepos/updates"
  4612. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  4613. PACKAGE_FEED_ARCHS = "all core2-64"
  4614. Given these settings, the resulting package feeds are as follows:
  4615. .. code-block:: none
  4616. https://example.com/packagerepos/release/rpm/all
  4617. https://example.com/packagerepos/release/rpm/core2-64
  4618. https://example.com/packagerepos/release/rpm-dev/all
  4619. https://example.com/packagerepos/release/rpm-dev/core2-64
  4620. https://example.com/packagerepos/updates/rpm/all
  4621. https://example.com/packagerepos/updates/rpm/core2-64
  4622. https://example.com/packagerepos/updates/rpm-dev/all
  4623. https://example.com/packagerepos/updates/rpm-dev/core2-64
  4624. :term:`PACKAGE_FEED_BASE_PATHS`
  4625. Specifies the base path used when constructing package feed URIs. The
  4626. :term:`PACKAGE_FEED_BASE_PATHS` variable makes up the middle portion of a
  4627. package feed URI used by the OpenEmbedded build system. The base path
  4628. lies between the :term:`PACKAGE_FEED_URIS`
  4629. and :term:`PACKAGE_FEED_ARCHS` variables.
  4630. Consider the following example where the :term:`PACKAGE_FEED_URIS`,
  4631. :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables are
  4632. defined in your ``local.conf`` file::
  4633. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  4634. https://example.com/packagerepos/updates"
  4635. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  4636. PACKAGE_FEED_ARCHS = "all core2-64"
  4637. Given these settings, the resulting package feeds are as follows:
  4638. .. code-block:: none
  4639. https://example.com/packagerepos/release/rpm/all
  4640. https://example.com/packagerepos/release/rpm/core2-64
  4641. https://example.com/packagerepos/release/rpm-dev/all
  4642. https://example.com/packagerepos/release/rpm-dev/core2-64
  4643. https://example.com/packagerepos/updates/rpm/all
  4644. https://example.com/packagerepos/updates/rpm/core2-64
  4645. https://example.com/packagerepos/updates/rpm-dev/all
  4646. https://example.com/packagerepos/updates/rpm-dev/core2-64
  4647. :term:`PACKAGE_FEED_URIS`
  4648. Specifies the front portion of the package feed URI used by the
  4649. OpenEmbedded build system. Each final package feed URI is comprised
  4650. of :term:`PACKAGE_FEED_URIS`,
  4651. :term:`PACKAGE_FEED_BASE_PATHS`, and
  4652. :term:`PACKAGE_FEED_ARCHS` variables.
  4653. Consider the following example where the :term:`PACKAGE_FEED_URIS`,
  4654. :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables are
  4655. defined in your ``local.conf`` file::
  4656. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  4657. https://example.com/packagerepos/updates"
  4658. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  4659. PACKAGE_FEED_ARCHS = "all core2-64"
  4660. Given these settings, the resulting package feeds are as follows:
  4661. .. code-block:: none
  4662. https://example.com/packagerepos/release/rpm/all
  4663. https://example.com/packagerepos/release/rpm/core2-64
  4664. https://example.com/packagerepos/release/rpm-dev/all
  4665. https://example.com/packagerepos/release/rpm-dev/core2-64
  4666. https://example.com/packagerepos/updates/rpm/all
  4667. https://example.com/packagerepos/updates/rpm/core2-64
  4668. https://example.com/packagerepos/updates/rpm-dev/all
  4669. https://example.com/packagerepos/updates/rpm-dev/core2-64
  4670. :term:`PACKAGE_INSTALL`
  4671. The final list of packages passed to the package manager for
  4672. installation into the image.
  4673. Because the package manager controls actual installation of all
  4674. packages, the list of packages passed using :term:`PACKAGE_INSTALL` is
  4675. not the final list of packages that are actually installed. This
  4676. variable is internal to the image construction code. Consequently, in
  4677. general, you should use the
  4678. :term:`IMAGE_INSTALL` variable to specify
  4679. packages for installation. The exception to this is when working with
  4680. the :ref:`core-image-minimal-initramfs <ref-manual/images:images>`
  4681. image. When working with an initial RAM filesystem (:term:`Initramfs`) image,
  4682. use the :term:`PACKAGE_INSTALL` variable. For information on creating an
  4683. :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section
  4684. in the Yocto Project Development Tasks Manual.
  4685. :term:`PACKAGE_INSTALL_ATTEMPTONLY`
  4686. Specifies a list of packages the OpenEmbedded build system attempts
  4687. to install when creating an image. If a listed package fails to
  4688. install, the build system does not generate an error. This variable
  4689. is generally not user-defined.
  4690. :term:`PACKAGE_PREPROCESS_FUNCS`
  4691. Specifies a list of functions run to pre-process the
  4692. :term:`PKGD` directory prior to splitting the files out
  4693. to individual packages.
  4694. :term:`PACKAGE_WRITE_DEPS`
  4695. Specifies a list of dependencies for post-installation and
  4696. pre-installation scripts on native/cross tools. If your
  4697. post-installation or pre-installation script can execute at root filesystem
  4698. creation time rather than on the target but depends on a native tool
  4699. in order to execute, you need to list the tools in
  4700. :term:`PACKAGE_WRITE_DEPS`.
  4701. For information on running post-installation scripts, see the
  4702. ":ref:`dev-manual/new-recipe:post-installation scripts`"
  4703. section in the Yocto Project Development Tasks Manual.
  4704. :term:`PACKAGECONFIG`
  4705. This variable provides a means of enabling or disabling features of a
  4706. recipe on a per-recipe basis. :term:`PACKAGECONFIG` blocks are defined in
  4707. recipes when you specify features and then arguments that define
  4708. feature behaviors. Here is the basic block structure (broken over
  4709. multiple lines for readability)::
  4710. PACKAGECONFIG ??= "f1 f2 f3 ..."
  4711. PACKAGECONFIG[f1] = "\
  4712. --with-f1, \
  4713. --without-f1, \
  4714. build-deps-for-f1, \
  4715. runtime-deps-for-f1, \
  4716. runtime-recommends-for-f1, \
  4717. packageconfig-conflicts-for-f1"
  4718. PACKAGECONFIG[f2] = "\
  4719. ... and so on and so on ...
  4720. The :term:`PACKAGECONFIG` variable itself specifies a space-separated
  4721. list of the features to enable. Following the features, you can
  4722. determine the behavior of each feature by providing up to six
  4723. order-dependent arguments, which are separated by commas. You can
  4724. omit any argument you like but must retain the separating commas. The
  4725. order is important and specifies the following:
  4726. #. Extra arguments that should be added to :term:`PACKAGECONFIG_CONFARGS`
  4727. if the feature is enabled.
  4728. #. Extra arguments that should be added to :term:`PACKAGECONFIG_CONFARGS`
  4729. if the feature is disabled.
  4730. #. Additional build dependencies (:term:`DEPENDS`)
  4731. that should be added if the feature is enabled.
  4732. #. Additional runtime dependencies (:term:`RDEPENDS`)
  4733. that should be added if the feature is enabled.
  4734. #. Additional runtime recommendations
  4735. (:term:`RRECOMMENDS`) that should be added if
  4736. the feature is enabled.
  4737. #. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG`
  4738. settings for this feature.
  4739. Consider the following :term:`PACKAGECONFIG` block taken from the
  4740. ``librsvg`` recipe. In this example the feature is ``gtk``, which has
  4741. three arguments that determine the feature's behavior::
  4742. PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3"
  4743. The
  4744. ``--with-gtk3`` and ``gtk+3`` arguments apply only if the feature is
  4745. enabled. In this case, ``--with-gtk3`` is added to the configure
  4746. script argument list and ``gtk+3`` is added to :term:`DEPENDS`. On the
  4747. other hand, if the feature is disabled say through a ``.bbappend``
  4748. file in another layer, then the second argument ``--without-gtk3`` is
  4749. added to the configure script instead.
  4750. The basic :term:`PACKAGECONFIG` structure previously described holds true
  4751. regardless of whether you are creating a block or changing a block.
  4752. When creating a block, use the structure inside your recipe.
  4753. If you want to change an existing :term:`PACKAGECONFIG` block, you can do
  4754. so one of two ways:
  4755. - *Append file:* Create an append file named
  4756. ``recipename.bbappend`` in your layer and override the value of
  4757. :term:`PACKAGECONFIG`. You can either completely override the
  4758. variable::
  4759. PACKAGECONFIG = "f4 f5"
  4760. Or, you can just append the variable::
  4761. PACKAGECONFIG:append = " f4"
  4762. - *Configuration file:* This method is identical to changing the
  4763. block through an append file except you edit your ``local.conf``
  4764. or ``mydistro.conf`` file. As with append files previously
  4765. described, you can either completely override the variable::
  4766. PACKAGECONFIG:pn-recipename = "f4 f5"
  4767. Or, you can just amend the variable::
  4768. PACKAGECONFIG:append:pn-recipename = " f4"
  4769. Consider the following example of a :ref:`ref-classes-cmake` recipe with a systemd service
  4770. in which :term:`PACKAGECONFIG` is used to transform the systemd service
  4771. into a feature that can be easily enabled or disabled via :term:`PACKAGECONFIG`::
  4772. example.c
  4773. example.service
  4774. CMakeLists.txt
  4775. The ``CMakeLists.txt`` file contains::
  4776. if(WITH_SYSTEMD)
  4777. install(FILES ${PROJECT_SOURCE_DIR}/example.service DESTINATION /etc/systemd/systemd)
  4778. endif(WITH_SYSTEMD)
  4779. In order to enable the installation of ``example.service`` we need to
  4780. ensure that ``-DWITH_SYSTEMD=ON`` is passed to the ``cmake`` command
  4781. execution. Recipes that have ``CMakeLists.txt`` generally inherit the
  4782. :ref:`ref-classes-cmake` class, that runs ``cmake`` with
  4783. :term:`EXTRA_OECMAKE`, which :term:`PACKAGECONFIG_CONFARGS` will be
  4784. appended to. Now, knowing that :term:`PACKAGECONFIG_CONFARGS` is
  4785. automatically filled with either the first or second element of
  4786. :term:`PACKAGECONFIG` flag value, the recipe would be like::
  4787. inherit cmake
  4788. PACKAGECONFIG = "systemd"
  4789. PACKAGECONFIG[systemd] = "-DWITH_SYSTEMD=ON,-DWITH_SYSTEMD=OFF"
  4790. A side note to this recipe is to check if ``systemd`` is in fact the used :term:`INIT_MANAGER`
  4791. or not::
  4792. PACKAGECONFIG = "${@'systemd' if d.getVar('INIT_MANAGER') == 'systemd' else ''}"
  4793. :term:`PACKAGECONFIG_CONFARGS`
  4794. A space-separated list of configuration options generated from the
  4795. :term:`PACKAGECONFIG` setting.
  4796. Classes such as :ref:`ref-classes-autotools` and :ref:`ref-classes-cmake`
  4797. use :term:`PACKAGECONFIG_CONFARGS` to pass :term:`PACKAGECONFIG` options
  4798. to ``configure`` and ``cmake``, respectively. If you are using
  4799. :term:`PACKAGECONFIG` but not a class that handles the
  4800. :ref:`ref-tasks-configure` task, then you need to use
  4801. :term:`PACKAGECONFIG_CONFARGS` appropriately.
  4802. :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY`
  4803. For recipes inheriting the :ref:`ref-classes-packagegroup` class, setting
  4804. :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` to "1" specifies that the
  4805. normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth)
  4806. should not be automatically created by the ``packagegroup`` recipe,
  4807. which is the default behavior.
  4808. :term:`PACKAGES`
  4809. The list of packages the recipe creates. The default value is the
  4810. following::
  4811. ${PN}-src ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
  4812. During packaging, the :ref:`ref-tasks-package` task
  4813. goes through :term:`PACKAGES` and uses the :term:`FILES`
  4814. variable corresponding to each package to assign files to the
  4815. package. If a file matches the :term:`FILES` variable for more than one
  4816. package in :term:`PACKAGES`, it will be assigned to the earliest
  4817. (leftmost) package.
  4818. Packages in the variable's list that are empty (i.e. where none of
  4819. the patterns in ``FILES:``\ pkg match any files installed by the
  4820. :ref:`ref-tasks-install` task) are not generated,
  4821. unless generation is forced through the
  4822. :term:`ALLOW_EMPTY` variable.
  4823. :term:`PACKAGES_DYNAMIC`
  4824. A promise that your recipe satisfies runtime dependencies for
  4825. optional modules that are found in other recipes.
  4826. :term:`PACKAGES_DYNAMIC` does not actually satisfy the dependencies, it
  4827. only states that they should be satisfied. For example, if a hard,
  4828. runtime dependency (:term:`RDEPENDS`) of another
  4829. package is satisfied at build time through the :term:`PACKAGES_DYNAMIC`
  4830. variable, but a package with the module name is never actually
  4831. produced, then the other package will be broken. Thus, if you attempt
  4832. to include that package in an image, you will get a dependency
  4833. failure from the packaging system during the
  4834. :ref:`ref-tasks-rootfs` task.
  4835. Typically, if there is a chance that such a situation can occur and
  4836. the package that is not created is valid without the dependency being
  4837. satisfied, then you should use :term:`RRECOMMENDS`
  4838. (a soft runtime dependency) instead of :term:`RDEPENDS`.
  4839. For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when
  4840. you are splitting packages, see the
  4841. ":ref:`dev-manual/packages:handling optional module packaging`"
  4842. section in the Yocto Project Development Tasks Manual.
  4843. :term:`PACKAGESPLITFUNCS`
  4844. Specifies a list of functions run to perform additional splitting of
  4845. files into individual packages. Recipes can either prepend to this
  4846. variable or prepend to the ``populate_packages`` function in order to
  4847. perform additional package splitting. In either case, the function
  4848. should set :term:`PACKAGES`,
  4849. :term:`FILES`, :term:`RDEPENDS` and
  4850. other packaging variables appropriately in order to perform the
  4851. desired splitting.
  4852. :term:`PARALLEL_MAKE`
  4853. Extra options passed to the build tool command (``make``,
  4854. ``ninja`` or more specific build engines, like the Go language one)
  4855. during the :ref:`ref-tasks-compile` task, to specify parallel compilation
  4856. on the local build host. This variable is usually in the form "-j x",
  4857. where x represents the maximum number of parallel threads such engines
  4858. can run.
  4859. .. note::
  4860. For software compiled by ``make``, in order for :term:`PARALLEL_MAKE`
  4861. to be effective, ``make`` must be called with
  4862. ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy
  4863. way to ensure this is to use the ``oe_runmake`` function.
  4864. By default, the OpenEmbedded build system automatically sets this
  4865. variable to be equal to the number of cores the build system uses.
  4866. .. note::
  4867. If the software being built experiences dependency issues during
  4868. the :ref:`ref-tasks-compile` task that result in race conditions, you can clear
  4869. the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For
  4870. information on addressing race conditions, see the
  4871. ":ref:`dev-manual/debugging:debugging parallel make races`"
  4872. section in the Yocto Project Development Tasks Manual.
  4873. For single socket systems (i.e. one CPU), you should not have to
  4874. override this variable to gain optimal parallelism during builds.
  4875. However, if you have very large systems that employ multiple physical
  4876. CPUs, you might want to make sure the :term:`PARALLEL_MAKE` variable is
  4877. not set higher than "-j 20".
  4878. For more information on speeding up builds, see the
  4879. ":ref:`dev-manual/speeding-up-build:speeding up a build`"
  4880. section in the Yocto Project Development Tasks Manual.
  4881. :term:`PARALLEL_MAKEINST`
  4882. Extra options passed to the build tool install command
  4883. (``make install``, ``ninja install`` or more specific ones)
  4884. during the :ref:`ref-tasks-install` task in order to specify
  4885. parallel installation. This variable defaults to the value of
  4886. :term:`PARALLEL_MAKE`.
  4887. .. note::
  4888. For software compiled by ``make``, in order for :term:`PARALLEL_MAKEINST`
  4889. to be effective, ``make`` must be called with
  4890. ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy
  4891. way to ensure this is to use the ``oe_runmake`` function.
  4892. If the software being built experiences dependency issues during
  4893. the :ref:`ref-tasks-install` task that result in race conditions, you can
  4894. clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a
  4895. workaround. For information on addressing race conditions, see the
  4896. ":ref:`dev-manual/debugging:debugging parallel make races`"
  4897. section in the Yocto Project Development Tasks Manual.
  4898. :term:`PATCHRESOLVE`
  4899. Determines the action to take when a patch fails. You can set this
  4900. variable to one of two values: "noop" and "user".
  4901. The default value of "noop" causes the build to simply fail when the
  4902. OpenEmbedded build system cannot successfully apply a patch. Setting
  4903. the value to "user" causes the build system to launch a shell and
  4904. places you in the right location so that you can manually resolve the
  4905. conflicts.
  4906. Set this variable in your ``local.conf`` file.
  4907. :term:`PATCHTOOL`
  4908. Specifies the utility used to apply patches for a recipe during the
  4909. :ref:`ref-tasks-patch` task. You can specify one of
  4910. three utilities: "patch", "quilt", or "git". The default utility used
  4911. is "quilt" except for the quilt-native recipe itself. Because the
  4912. quilt tool is not available at the time quilt-native is being
  4913. patched, it uses "patch".
  4914. If you wish to use an alternative patching tool, set the variable in
  4915. the recipe using one of the following::
  4916. PATCHTOOL = "patch"
  4917. PATCHTOOL = "quilt"
  4918. PATCHTOOL = "git"
  4919. :term:`PE`
  4920. The epoch of the recipe. By default, this variable is unset. The
  4921. variable is used to make upgrades possible when the versioning scheme
  4922. changes in some backwards incompatible way.
  4923. :term:`PE` is the default value of the :term:`PKGE` variable.
  4924. :term:`PEP517_WHEEL_PATH`
  4925. When used by recipes that inherit the :ref:`ref-classes-python_pep517`
  4926. class, denotes the path to ``dist/`` (short for distribution) where the
  4927. binary archive ``wheel`` is built.
  4928. :term:`PERSISTENT_DIR`
  4929. See :term:`bitbake:PERSISTENT_DIR` in the BitBake manual.
  4930. :term:`PF`
  4931. Specifies the recipe or package name and includes all version and
  4932. revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and
  4933. ``bash-4.2-r1/``). This variable is comprised of the following:
  4934. ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`}
  4935. :term:`PIXBUF_PACKAGES`
  4936. When inheriting the :ref:`ref-classes-pixbufcache`
  4937. class, this variable identifies packages that contain the pixbuf
  4938. loaders used with ``gdk-pixbuf``. By default, the
  4939. :ref:`ref-classes-pixbufcache` class assumes that
  4940. the loaders are in the recipe's main package (i.e.
  4941. ``${``\ :term:`PN`\ ``}``). Use this variable if the
  4942. loaders you need are in a package other than that main package.
  4943. :term:`PKG`
  4944. The name of the resulting package created by the OpenEmbedded build
  4945. system.
  4946. .. note::
  4947. When using the :term:`PKG` variable, you must use a package name override.
  4948. For example, when the :ref:`ref-classes-debian` class renames the output
  4949. package, it does so by setting ``PKG:packagename``.
  4950. :term:`PKG_CONFIG_PATH`
  4951. The path to ``pkg-config`` files for the current build context.
  4952. ``pkg-config`` reads this variable from the environment.
  4953. :term:`PKGD`
  4954. Points to the destination directory for files to be packaged before
  4955. they are split into individual packages. This directory defaults to
  4956. the following::
  4957. ${WORKDIR}/package
  4958. Do not change this default.
  4959. :term:`PKGDATA_DIR`
  4960. Points to a shared, global-state directory that holds data generated
  4961. during the packaging process. During the packaging process, the
  4962. :ref:`ref-tasks-packagedata` task packages data
  4963. for each recipe and installs it into this temporary, shared area.
  4964. This directory defaults to the following, which you should not
  4965. change::
  4966. ${STAGING_DIR_HOST}/pkgdata
  4967. For examples of how this data is used, see the
  4968. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  4969. section in the Yocto Project Overview and Concepts Manual and the
  4970. ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``"
  4971. section in the Yocto Project Development Tasks Manual. For more
  4972. information on the shared, global-state directory, see
  4973. :term:`STAGING_DIR_HOST`.
  4974. :term:`PKGDEST`
  4975. Points to the parent directory for files to be packaged after they
  4976. have been split into individual packages. This directory defaults to
  4977. the following::
  4978. ${WORKDIR}/packages-split
  4979. Under this directory, the build system creates directories for each
  4980. package specified in :term:`PACKAGES`. Do not change
  4981. this default.
  4982. :term:`PKGDESTWORK`
  4983. Points to a temporary work area where the
  4984. :ref:`ref-tasks-package` task saves package metadata.
  4985. The :term:`PKGDESTWORK` location defaults to the following::
  4986. ${WORKDIR}/pkgdata
  4987. Do not change this default.
  4988. The :ref:`ref-tasks-packagedata` task copies the
  4989. package metadata from :term:`PKGDESTWORK` to
  4990. :term:`PKGDATA_DIR` to make it available globally.
  4991. :term:`PKGE`
  4992. The epoch of the package(s) built by the recipe. By default, :term:`PKGE`
  4993. is set to :term:`PE`.
  4994. :term:`PKGR`
  4995. The revision of the package(s) built by the recipe. By default,
  4996. :term:`PKGR` is set to :term:`PR`.
  4997. :term:`PKGV`
  4998. The version of the package(s) built by the recipe. By default,
  4999. :term:`PKGV` is set to :term:`PV`.
  5000. :term:`PN`
  5001. This variable can have two separate functions depending on the
  5002. context: a recipe name or a resulting package name.
  5003. :term:`PN` refers to a recipe name in the context of a file used by the
  5004. OpenEmbedded build system as input to create a package. The name is
  5005. normally extracted from the recipe file name. For example, if the
  5006. recipe is named ``expat_2.0.1.bb``, then the default value of :term:`PN`
  5007. will be "expat".
  5008. The variable refers to a package name in the context of a file
  5009. created or produced by the OpenEmbedded build system.
  5010. If applicable, the :term:`PN` variable also contains any special suffix
  5011. or prefix. For example, using ``bash`` to build packages for the
  5012. native machine, :term:`PN` is ``bash-native``. Using ``bash`` to build
  5013. packages for the target and for Multilib, :term:`PN` would be ``bash``
  5014. and ``lib64-bash``, respectively.
  5015. :term:`POPULATE_SDK_POST_HOST_COMMAND`
  5016. Specifies a list of functions to call once the OpenEmbedded build
  5017. system has created the host part of the SDK. You can specify
  5018. functions separated by spaces::
  5019. POPULATE_SDK_POST_HOST_COMMAND += "function"
  5020. If you need to pass the SDK path to a command within a function, you
  5021. can use ``${SDK_DIR}``, which points to the parent directory used by
  5022. the OpenEmbedded build system when creating SDK output. See the
  5023. :term:`SDK_DIR` variable for more information.
  5024. :term:`POPULATE_SDK_POST_TARGET_COMMAND`
  5025. Specifies a list of functions to call once the OpenEmbedded build
  5026. system has created the target part of the SDK. You can specify
  5027. functions separated by spaces::
  5028. POPULATE_SDK_POST_TARGET_COMMAND += "function"
  5029. If you need to pass the SDK path to a command within a function, you
  5030. can use ``${SDK_DIR}``, which points to the parent directory used by
  5031. the OpenEmbedded build system when creating SDK output. See the
  5032. :term:`SDK_DIR` variable for more information.
  5033. :term:`PR`
  5034. The revision of the recipe. The default value for this variable is
  5035. "r0". Subsequent revisions of the recipe conventionally have the
  5036. values "r1", "r2", and so forth. When :term:`PV` increases,
  5037. :term:`PR` is conventionally reset to "r0".
  5038. .. note::
  5039. The OpenEmbedded build system does not need the aid of :term:`PR`
  5040. to know when to rebuild a recipe. The build system uses the task
  5041. :ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the
  5042. :ref:`stamp <structure-build-tmp-stamps>` and
  5043. :ref:`overview-manual/concepts:shared state cache`
  5044. mechanisms.
  5045. The :term:`PR` variable primarily becomes significant when a package
  5046. manager dynamically installs packages on an already built image. In
  5047. this case, :term:`PR`, which is the default value of
  5048. :term:`PKGR`, helps the package manager distinguish which
  5049. package is the most recent one in cases where many packages have the
  5050. same :term:`PV` (i.e. :term:`PKGV`). A component having many packages with
  5051. the same :term:`PV` usually means that the packages all install the same
  5052. upstream version, but with later (:term:`PR`) version packages including
  5053. packaging fixes.
  5054. .. note::
  5055. :term:`PR` does not need to be increased for changes that do not change the
  5056. package contents or metadata.
  5057. Because manually managing :term:`PR` can be cumbersome and error-prone,
  5058. an automated solution exists. See the
  5059. ":ref:`dev-manual/packages:working with a pr service`" section
  5060. in the Yocto Project Development Tasks Manual for more information.
  5061. :term:`PREFERRED_PROVIDER`
  5062. If multiple recipes provide the same item, this variable determines
  5063. which recipe is preferred and thus provides the item (i.e. the
  5064. preferred provider). You should always suffix this variable with the
  5065. name of the provided item. And, you should define the variable using
  5066. the preferred recipe's name (:term:`PN`). Here is a common
  5067. example::
  5068. PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
  5069. In the previous example, multiple recipes are providing "virtual/kernel".
  5070. The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of
  5071. the recipe you prefer to provide "virtual/kernel".
  5072. Here are more examples::
  5073. PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
  5074. PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
  5075. For more
  5076. information, see the ":ref:`dev-manual/new-recipe:using virtual providers`"
  5077. section in the Yocto Project Development Tasks Manual.
  5078. .. note::
  5079. If you use a ``virtual/\*`` item with :term:`PREFERRED_PROVIDER`, then any
  5080. recipe that :term:`PROVIDES` that item but is not selected (defined)
  5081. by :term:`PREFERRED_PROVIDER` is prevented from building, which is usually
  5082. desirable since this mechanism is designed to select between mutually
  5083. exclusive alternative providers.
  5084. :term:`PREFERRED_PROVIDERS`
  5085. See :term:`bitbake:PREFERRED_PROVIDERS` in the BitBake manual.
  5086. :term:`PREFERRED_VERSION`
  5087. If there are multiple versions of a recipe available, this variable
  5088. determines which version should be given preference. You must always
  5089. suffix the variable with the :term:`PN` you want to select (`python` in
  5090. the first example below), and you should specify the :term:`PV`
  5091. accordingly (`3.4.0` in the example).
  5092. The :term:`PREFERRED_VERSION` variable supports limited wildcard use
  5093. through the "``%``" character. You can use the character to match any
  5094. number of characters, which can be useful when specifying versions
  5095. that contain long revision numbers that potentially change. Here are
  5096. two examples::
  5097. PREFERRED_VERSION_python = "3.4.0"
  5098. PREFERRED_VERSION_linux-yocto = "5.0%"
  5099. .. note::
  5100. The use of the "%" character is limited in that it only works at the end of the
  5101. string. You cannot use the wildcard character in any other
  5102. location of the string.
  5103. The specified version is matched against :term:`PV`, which
  5104. does not necessarily match the version part of the recipe's filename.
  5105. For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb``
  5106. where ``foo_git.bb`` contains the following assignment::
  5107. PV = "1.1+git${SRCPV}"
  5108. In this case, the correct way to select
  5109. ``foo_git.bb`` is by using an assignment such as the following::
  5110. PREFERRED_VERSION_foo = "1.1+git%"
  5111. Compare that previous example
  5112. against the following incorrect example, which does not work::
  5113. PREFERRED_VERSION_foo = "git"
  5114. Sometimes the :term:`PREFERRED_VERSION` variable can be set by
  5115. configuration files in a way that is hard to change. You can use
  5116. :term:`OVERRIDES` to set a machine-specific
  5117. override. Here is an example::
  5118. PREFERRED_VERSION_linux-yocto:qemux86 = "5.0%"
  5119. Although not recommended, worst case, you can also use the
  5120. "forcevariable" override, which is the strongest override possible.
  5121. Here is an example::
  5122. PREFERRED_VERSION_linux-yocto:forcevariable = "5.0%"
  5123. .. note::
  5124. The ``:forcevariable`` override is not handled specially. This override
  5125. only works because the default value of :term:`OVERRIDES` includes "forcevariable".
  5126. If a recipe with the specified version is not available, a warning
  5127. message will be shown. See :term:`REQUIRED_VERSION` if you want this
  5128. to be an error instead.
  5129. :term:`PREMIRRORS`
  5130. Specifies additional paths from which the OpenEmbedded build system
  5131. gets source code. When the build system searches for source code, it
  5132. first tries the local download directory. If that location fails, the
  5133. build system tries locations defined by :term:`PREMIRRORS`, the upstream
  5134. source, and then locations specified by
  5135. :term:`MIRRORS` in that order.
  5136. The default value for :term:`PREMIRRORS` is defined in the
  5137. ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer.
  5138. Typically, you could add a specific server for the build system to
  5139. attempt before any others by adding something like the following to
  5140. the ``local.conf`` configuration file in the
  5141. :term:`Build Directory`::
  5142. PREMIRRORS:prepend = "\
  5143. git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \
  5144. ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \
  5145. http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \
  5146. https://.*/.* &YOCTO_DL_URL;/mirror/sources/"
  5147. These changes cause the
  5148. build system to intercept Git, FTP, HTTP, and HTTPS requests and
  5149. direct them to the ``http://`` sources mirror. You can use
  5150. ``file://`` URLs to point to local directories or network shares as
  5151. well.
  5152. :term:`PRIORITY`
  5153. Indicates the importance of a package.
  5154. :term:`PRIORITY` is considered to be part of the distribution policy
  5155. because the importance of any given recipe depends on the purpose for
  5156. which the distribution is being produced. Thus, :term:`PRIORITY` is not
  5157. normally set within recipes.
  5158. You can set :term:`PRIORITY` to "required", "standard", "extra", and
  5159. "optional", which is the default.
  5160. :term:`PRIVATE_LIBS`
  5161. Specifies libraries installed within a recipe that should be ignored
  5162. by the OpenEmbedded build system's shared library resolver. This
  5163. variable is typically used when software being built by a recipe has
  5164. its own private versions of a library normally provided by another
  5165. recipe. In this case, you would not want the package containing the
  5166. private libraries to be set as a dependency on other unrelated
  5167. packages that should instead depend on the package providing the
  5168. standard version of the library.
  5169. Libraries specified in this variable should be specified by their
  5170. file name. For example, from the Firefox recipe in meta-browser::
  5171. PRIVATE_LIBS = "libmozjs.so \
  5172. libxpcom.so \
  5173. libnspr4.so \
  5174. libxul.so \
  5175. libmozalloc.so \
  5176. libplc4.so \
  5177. libplds4.so"
  5178. For more information, see the
  5179. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  5180. section in the Yocto Project Overview and Concepts Manual.
  5181. :term:`PROVIDES`
  5182. A list of aliases by which a particular recipe can be known. By
  5183. default, a recipe's own :term:`PN` is implicitly already in its
  5184. :term:`PROVIDES` list and therefore does not need to mention that it
  5185. provides itself. If a recipe uses :term:`PROVIDES`, the additional
  5186. aliases are synonyms for the recipe and can be useful for satisfying
  5187. dependencies of other recipes during the build as specified by
  5188. :term:`DEPENDS`.
  5189. Consider the following example :term:`PROVIDES` statement from the recipe
  5190. file ``eudev_3.2.9.bb``::
  5191. PROVIDES += "udev"
  5192. The :term:`PROVIDES` statement
  5193. results in the "eudev" recipe also being available as simply "udev".
  5194. .. note::
  5195. A recipe's own recipe name (:term:`PN`) is always implicitly prepended
  5196. to :term:`PROVIDES`, so while using "+=" in the above example may not be
  5197. strictly necessary it is recommended to avoid confusion.
  5198. In addition to providing recipes under alternate names, the
  5199. :term:`PROVIDES` mechanism is also used to implement virtual targets. A
  5200. virtual target is a name that corresponds to some particular
  5201. functionality (e.g. a Linux kernel). Recipes that provide the
  5202. functionality in question list the virtual target in :term:`PROVIDES`.
  5203. Recipes that depend on the functionality in question can include the
  5204. virtual target in :term:`DEPENDS` to leave the choice of provider open.
  5205. Conventionally, virtual targets have names on the form
  5206. "virtual/function" (e.g. "virtual/kernel"). The slash is simply part
  5207. of the name and has no syntactical significance.
  5208. The :term:`PREFERRED_PROVIDER` variable is
  5209. used to select which particular recipe provides a virtual target.
  5210. .. note::
  5211. A corresponding mechanism for virtual runtime dependencies (packages)
  5212. exists. However, the mechanism does not depend on any special
  5213. functionality beyond ordinary variable assignments. For example,
  5214. :term:`VIRTUAL-RUNTIME_dev_manager <VIRTUAL-RUNTIME>` refers to the
  5215. package of the component that manages the ``/dev`` directory.
  5216. Setting the "preferred provider" for runtime dependencies is as
  5217. simple as using the following assignment in a configuration file::
  5218. VIRTUAL-RUNTIME_dev_manager = "udev"
  5219. :term:`PRSERV_HOST`
  5220. The network based :term:`PR` service host and port.
  5221. The ``conf/templates/default/local.conf.sample.extended`` configuration
  5222. file in the :term:`Source Directory` shows how the :term:`PRSERV_HOST`
  5223. variable is set::
  5224. PRSERV_HOST = "localhost:0"
  5225. You must
  5226. set the variable if you want to automatically start a local :ref:`PR
  5227. service <dev-manual/packages:working with a pr service>`. You can
  5228. set :term:`PRSERV_HOST` to other values to use a remote PR service.
  5229. :term:`PSEUDO_IGNORE_PATHS`
  5230. A comma-separated (without spaces) list of path prefixes that should be ignored
  5231. by pseudo when monitoring and recording file operations, in order to avoid
  5232. problems with files being written to outside of the pseudo context and
  5233. reduce pseudo's overhead. A path is ignored if it matches any prefix in the list
  5234. and can include partial directory (or file) names.
  5235. :term:`PTEST_ENABLED`
  5236. Specifies whether or not :ref:`Package
  5237. Test <dev-manual/packages:testing packages with ptest>` (ptest)
  5238. functionality is enabled when building a recipe. You should not set
  5239. this variable directly. Enabling and disabling building Package Tests
  5240. at build time should be done by adding "ptest" to (or removing it
  5241. from) :term:`DISTRO_FEATURES`.
  5242. :term:`PV`
  5243. The version of the recipe. The version is normally extracted from the
  5244. recipe filename. For example, if the recipe is named
  5245. ``expat_2.0.1.bb``, then the default value of :term:`PV` will be "2.0.1".
  5246. :term:`PV` is generally not overridden within a recipe unless it is
  5247. building an unstable (i.e. development) version from a source code
  5248. repository (e.g. Git or Subversion).
  5249. :term:`PV` is the default value of the :term:`PKGV` variable.
  5250. :term:`PYPI_PACKAGE`
  5251. When inheriting the :ref:`ref-classes-pypi` class, specifies the
  5252. `PyPI <https://pypi.org/>`__ package name to be built. The default value
  5253. is set based upon :term:`BPN` (stripping any "python-" or "python3-"
  5254. prefix off if present), however for some packages it will need to be set
  5255. explicitly if that will not match the package name (e.g. where the
  5256. package name has a prefix, underscores, uppercase letters etc.)
  5257. :term:`PYTHON_ABI`
  5258. When used by recipes that inherit the :ref:`ref-classes-setuptools3`
  5259. class, denotes the Application Binary Interface (ABI) currently in use
  5260. for Python. By default, the ABI is "m". You do not have to set this
  5261. variable as the OpenEmbedded build system sets it for you.
  5262. The OpenEmbedded build system uses the ABI to construct directory
  5263. names used when installing the Python headers and libraries in
  5264. sysroot (e.g. ``.../python3.3m/...``).
  5265. :term:`QA_EMPTY_DIRS`
  5266. Specifies a list of directories that are expected to be empty when
  5267. packaging; if ``empty-dirs`` appears in :term:`ERROR_QA` or
  5268. :term:`WARN_QA` these will be checked and an error or warning
  5269. (respectively) will be produced.
  5270. The default :term:`QA_EMPTY_DIRS` value is set in
  5271. :ref:`insane.bbclass <ref-classes-insane>`.
  5272. :term:`QA_EMPTY_DIRS_RECOMMENDATION`
  5273. Specifies a recommendation for why a directory must be empty,
  5274. which will be included in the error message if a specific directory
  5275. is found to contain files. Must be overridden with the directory
  5276. path to match on.
  5277. If no recommendation is specified for a directory, then the default
  5278. "but it is expected to be empty" will be used.
  5279. An example message shows if files were present in '/dev'::
  5280. QA_EMPTY_DIRS_RECOMMENDATION:/dev = "but all devices must be created at runtime"
  5281. :term:`RANLIB`
  5282. The minimal command and arguments to run ``ranlib``.
  5283. :term:`RCONFLICTS`
  5284. The list of packages that conflict with packages. Note that packages
  5285. will not be installed if conflicting packages are not first removed.
  5286. Like all package-controlling variables, you must always use them in
  5287. conjunction with a package name override. Here is an example::
  5288. RCONFLICTS:${PN} = "another_conflicting_package_name"
  5289. BitBake, which the OpenEmbedded build system uses, supports
  5290. specifying versioned dependencies. Although the syntax varies
  5291. depending on the packaging format, BitBake hides these differences
  5292. from you. Here is the general syntax to specify versions with the
  5293. :term:`RCONFLICTS` variable::
  5294. RCONFLICTS:${PN} = "package (operator version)"
  5295. For ``operator``, you can specify the following:
  5296. - =
  5297. - <
  5298. - >
  5299. - <=
  5300. - >=
  5301. For example, the following sets up a dependency on version 1.2 or
  5302. greater of the package ``foo``::
  5303. RCONFLICTS:${PN} = "foo (>= 1.2)"
  5304. :term:`RDEPENDS`
  5305. Lists runtime dependencies of a package. These dependencies are other
  5306. packages that must be installed in order for the package to function
  5307. correctly. As an example, the following assignment declares that the
  5308. package ``foo`` needs the packages ``bar`` and ``baz`` to be
  5309. installed::
  5310. RDEPENDS:foo = "bar baz"
  5311. The most common types of package
  5312. runtime dependencies are automatically detected and added. Therefore,
  5313. most recipes do not need to set :term:`RDEPENDS`. For more information,
  5314. see the
  5315. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  5316. section in the Yocto Project Overview and Concepts Manual.
  5317. The practical effect of the above :term:`RDEPENDS` assignment is that
  5318. ``bar`` and ``baz`` will be declared as dependencies inside the
  5319. package ``foo`` when it is written out by one of the
  5320. :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks.
  5321. Exactly how this is done depends on which package format is used,
  5322. which is determined by
  5323. :term:`PACKAGE_CLASSES`. When the
  5324. corresponding package manager installs the package, it will know to
  5325. also install the packages on which it depends.
  5326. To ensure that the packages ``bar`` and ``baz`` get built, the
  5327. previous :term:`RDEPENDS` assignment also causes a task dependency to be
  5328. added. This dependency is from the recipe's
  5329. :ref:`ref-tasks-build` (not to be confused with
  5330. :ref:`ref-tasks-compile`) task to the
  5331. :ref:`do_package_write_* <ref-tasks-package_write_deb>` task of the recipes that build ``bar`` and
  5332. ``baz``.
  5333. The names of the packages you list within :term:`RDEPENDS` must be the
  5334. names of other packages --- they cannot be recipe names. Although
  5335. package names and recipe names usually match, the important point
  5336. here is that you are providing package names within the :term:`RDEPENDS`
  5337. variable. For an example of the default list of packages created from
  5338. a recipe, see the :term:`PACKAGES` variable.
  5339. Because the :term:`RDEPENDS` variable applies to packages being built,
  5340. you should always use the variable in a form with an attached package
  5341. name (remember that a single recipe can build multiple packages). For
  5342. example, suppose you are building a development package that depends
  5343. on the ``perl`` package. In this case, you would use the following
  5344. :term:`RDEPENDS` statement::
  5345. RDEPENDS:${PN}-dev += "perl"
  5346. In the example,
  5347. the development package depends on the ``perl`` package. Thus, the
  5348. :term:`RDEPENDS` variable has the ``${PN}-dev`` package name as part of
  5349. the variable.
  5350. .. note::
  5351. ``RDEPENDS:${PN}-dev`` includes ``${``\ :term:`PN`\ ``}``
  5352. by default. This default is set in the BitBake configuration file
  5353. (``meta/conf/bitbake.conf``). Be careful not to accidentally remove
  5354. ``${PN}`` when modifying ``RDEPENDS:${PN}-dev``. Use the "+=" operator
  5355. rather than the "=" operator.
  5356. The package names you use with :term:`RDEPENDS` must appear as they would
  5357. in the :term:`PACKAGES` variable. The :term:`PKG` variable
  5358. allows a different name to be used for the final package (e.g. the
  5359. :ref:`ref-classes-debian` class uses this to rename
  5360. packages), but this final package name cannot be used with
  5361. :term:`RDEPENDS`, which makes sense as :term:`RDEPENDS` is meant to be
  5362. independent of the package format used.
  5363. BitBake, which the OpenEmbedded build system uses, supports
  5364. specifying versioned dependencies. Although the syntax varies
  5365. depending on the packaging format, BitBake hides these differences
  5366. from you. Here is the general syntax to specify versions with the
  5367. :term:`RDEPENDS` variable::
  5368. RDEPENDS:${PN} = "package (operator version)"
  5369. For ``operator``, you can specify the following:
  5370. - =
  5371. - <
  5372. - >
  5373. - <=
  5374. - >=
  5375. For version, provide the version number.
  5376. .. note::
  5377. You can use :term:`EXTENDPKGV` to provide a full package version
  5378. specification.
  5379. For example, the following sets up a dependency on version 1.2 or
  5380. greater of the package ``foo``::
  5381. RDEPENDS:${PN} = "foo (>= 1.2)"
  5382. For information on build-time dependencies, see the :term:`DEPENDS`
  5383. variable. You can also see the
  5384. ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and
  5385. ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the
  5386. BitBake User Manual for additional information on tasks and dependencies.
  5387. :term:`RECIPE_MAINTAINER`
  5388. This variable defines the name and e-mail address of the maintainer of a
  5389. recipe. Such information can be used by human users submitted changes,
  5390. and by automated tools to send notifications, for example about
  5391. vulnerabilities or source updates.
  5392. The variable can be defined in a global distribution :oe_git:`maintainers.inc
  5393. </openembedded-core/tree/meta/conf/distro/include/maintainers.inc>` file::
  5394. meta/conf/distro/include/maintainers.inc:RECIPE_MAINTAINER:pn-sysvinit = "Ross Burton <ross.burton@arm.com>"
  5395. It can also be directly defined in a recipe,
  5396. for example in the ``libgpiod`` one::
  5397. RECIPE_MAINTAINER = "Bartosz Golaszewski <brgl@bgdev.pl>"
  5398. :term:`RECIPE_NO_UPDATE_REASON`
  5399. If a recipe should not be replaced by a more recent upstream version,
  5400. putting the reason why in this variable in a recipe allows
  5401. ``devtool check-upgrade-status`` command to display it, as explained
  5402. in the ":ref:`ref-manual/devtool-reference:checking on the upgrade status of a recipe`"
  5403. section.
  5404. :term:`RECIPE_SYSROOT`
  5405. This variable points to the directory that holds all files populated from
  5406. recipes specified in :term:`DEPENDS`. As the name indicates,
  5407. think of this variable as a custom root (``/``) for the recipe that will be
  5408. used by the compiler in order to find headers and other files needed to complete
  5409. its job.
  5410. This variable is related to :term:`STAGING_DIR_HOST` or :term:`STAGING_DIR_TARGET`
  5411. according to the type of the recipe and the build target.
  5412. To better understand this variable, consider the following examples:
  5413. - For ``#include <header.h>``, ``header.h`` should be in ``"${RECIPE_SYSROOT}/usr/include"``
  5414. - For ``-lexample``, ``libexample.so`` should be in ``"${RECIPE_SYSROOT}/lib"``
  5415. or other library sysroot directories.
  5416. The default value is ``"${WORKDIR}/recipe-sysroot"``.
  5417. Do not modify it.
  5418. :term:`RECIPE_SYSROOT_NATIVE`
  5419. This is similar to :term:`RECIPE_SYSROOT` but the populated files are from
  5420. ``-native`` recipes. This allows a recipe built for the target machine to
  5421. use ``native`` tools.
  5422. This variable is related to :term:`STAGING_DIR_NATIVE`.
  5423. The default value is ``"${WORKDIR}/recipe-sysroot-native"``.
  5424. Do not modify it.
  5425. :term:`REPODIR`
  5426. See :term:`bitbake:REPODIR` in the BitBake manual.
  5427. :term:`REQUIRED_DISTRO_FEATURES`
  5428. When inheriting the :ref:`ref-classes-features_check`
  5429. class, this variable identifies distribution features that must exist
  5430. in the current configuration in order for the OpenEmbedded build
  5431. system to build the recipe. In other words, if the
  5432. :term:`REQUIRED_DISTRO_FEATURES` variable lists a feature that does not
  5433. appear in :term:`DISTRO_FEATURES` within the current configuration, then
  5434. the recipe will be skipped, and if the build system attempts to build
  5435. the recipe then an error will be triggered.
  5436. :term:`REQUIRED_VERSION`
  5437. If there are multiple versions of a recipe available, this variable
  5438. determines which version should be given preference.
  5439. :term:`REQUIRED_VERSION` works in exactly the same manner as
  5440. :term:`PREFERRED_VERSION`, except that if the specified version is not
  5441. available then an error message is shown and the build fails
  5442. immediately.
  5443. If both :term:`REQUIRED_VERSION` and :term:`PREFERRED_VERSION` are set
  5444. for the same recipe, the :term:`REQUIRED_VERSION` value applies.
  5445. :term:`RM_WORK_EXCLUDE`
  5446. With :ref:`ref-classes-rm-work` enabled, this variable
  5447. specifies a list of recipes whose work directories should not be removed.
  5448. See the ":ref:`ref-classes-rm-work`" section for more details.
  5449. :term:`ROOT_HOME`
  5450. Defines the root home directory. By default, this directory is set as
  5451. follows in the BitBake configuration file::
  5452. ROOT_HOME ??= "/home/root"
  5453. .. note::
  5454. This default value is likely used because some embedded solutions
  5455. prefer to have a read-only root filesystem and prefer to keep
  5456. writeable data in one place.
  5457. You can override the default by setting the variable in any layer or
  5458. in the ``local.conf`` file. Because the default is set using a "weak"
  5459. assignment (i.e. "??="), you can use either of the following forms to
  5460. define your override::
  5461. ROOT_HOME = "/root"
  5462. ROOT_HOME ?= "/root"
  5463. These
  5464. override examples use ``/root``, which is probably the most commonly
  5465. used override.
  5466. :term:`ROOTFS`
  5467. Indicates a filesystem image to include as the root filesystem.
  5468. The :term:`ROOTFS` variable is an optional variable used with the
  5469. :ref:`ref-classes-image-live` class.
  5470. :term:`ROOTFS_POSTINSTALL_COMMAND`
  5471. Specifies a list of functions to call after the OpenEmbedded build
  5472. system has installed packages. You can specify functions separated by
  5473. spaces::
  5474. ROOTFS_POSTINSTALL_COMMAND += "function"
  5475. If you need to pass the root filesystem path to a command within a
  5476. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  5477. directory that becomes the root filesystem image. See the
  5478. :term:`IMAGE_ROOTFS` variable for more
  5479. information.
  5480. :term:`ROOTFS_POSTPROCESS_COMMAND`
  5481. Specifies a list of functions to call once the OpenEmbedded build
  5482. system has created the root filesystem. You can specify functions
  5483. separated by spaces::
  5484. ROOTFS_POSTPROCESS_COMMAND += "function"
  5485. If you need to pass the root filesystem path to a command within a
  5486. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  5487. directory that becomes the root filesystem image. See the
  5488. :term:`IMAGE_ROOTFS` variable for more
  5489. information.
  5490. :term:`ROOTFS_POSTUNINSTALL_COMMAND`
  5491. Specifies a list of functions to call after the OpenEmbedded build
  5492. system has removed unnecessary packages. When runtime package
  5493. management is disabled in the image, several packages are removed
  5494. including ``base-passwd``, ``shadow``, and ``update-alternatives``.
  5495. You can specify functions separated by spaces::
  5496. ROOTFS_POSTUNINSTALL_COMMAND += "function"
  5497. If you need to pass the root filesystem path to a command within a
  5498. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  5499. directory that becomes the root filesystem image. See the
  5500. :term:`IMAGE_ROOTFS` variable for more
  5501. information.
  5502. :term:`ROOTFS_PREPROCESS_COMMAND`
  5503. Specifies a list of functions to call before the OpenEmbedded build
  5504. system has created the root filesystem. You can specify functions
  5505. separated by spaces::
  5506. ROOTFS_PREPROCESS_COMMAND += "function"
  5507. If you need to pass the root filesystem path to a command within a
  5508. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  5509. directory that becomes the root filesystem image. See the
  5510. :term:`IMAGE_ROOTFS` variable for more
  5511. information.
  5512. :term:`RPROVIDES`
  5513. A list of package name aliases that a package also provides. These
  5514. aliases are useful for satisfying runtime dependencies of other
  5515. packages both during the build and on the target (as specified by
  5516. :term:`RDEPENDS`).
  5517. .. note::
  5518. A package's own name is implicitly already in its :term:`RPROVIDES` list.
  5519. As with all package-controlling variables, you must always use the
  5520. variable in conjunction with a package name override. Here is an
  5521. example::
  5522. RPROVIDES:${PN} = "widget-abi-2"
  5523. :term:`RRECOMMENDS`
  5524. A list of packages that extends the usability of a package being
  5525. built. The package being built does not depend on this list of
  5526. packages in order to successfully build, but rather uses them for
  5527. extended usability. To specify runtime dependencies for packages, see
  5528. the :term:`RDEPENDS` variable.
  5529. The package manager will automatically install the :term:`RRECOMMENDS`
  5530. list of packages when installing the built package. However, you can
  5531. prevent listed packages from being installed by using the
  5532. :term:`BAD_RECOMMENDATIONS`,
  5533. :term:`NO_RECOMMENDATIONS`, and
  5534. :term:`PACKAGE_EXCLUDE` variables.
  5535. Packages specified in :term:`RRECOMMENDS` need not actually be produced.
  5536. However, there must be a recipe providing each package, either
  5537. through the :term:`PACKAGES` or
  5538. :term:`PACKAGES_DYNAMIC` variables or the
  5539. :term:`RPROVIDES` variable, or an error will occur
  5540. during the build. If such a recipe does exist and the package is not
  5541. produced, the build continues without error.
  5542. Because the :term:`RRECOMMENDS` variable applies to packages being built,
  5543. you should always attach an override to the variable to specify the
  5544. particular package whose usability is being extended. For example,
  5545. suppose you are building a development package that is extended to
  5546. support wireless functionality. In this case, you would use the
  5547. following::
  5548. RRECOMMENDS:${PN}-dev += "wireless_package_name"
  5549. In the
  5550. example, the package name (``${PN}-dev``) must appear as it would in
  5551. the :term:`PACKAGES` namespace before any renaming of the output package
  5552. by classes such as :ref:`ref-classes-debian`.
  5553. BitBake, which the OpenEmbedded build system uses, supports
  5554. specifying versioned recommends. Although the syntax varies depending
  5555. on the packaging format, BitBake hides these differences from you.
  5556. Here is the general syntax to specify versions with the
  5557. :term:`RRECOMMENDS` variable::
  5558. RRECOMMENDS:${PN} = "package (operator version)"
  5559. For ``operator``, you can specify the following:
  5560. - =
  5561. - <
  5562. - >
  5563. - <=
  5564. - >=
  5565. For example, the following sets up a recommend on version 1.2 or
  5566. greater of the package ``foo``::
  5567. RRECOMMENDS:${PN} = "foo (>= 1.2)"
  5568. :term:`RREPLACES`
  5569. A list of packages replaced by a package. The package manager uses
  5570. this variable to determine which package should be installed to
  5571. replace other package(s) during an upgrade. In order to also have the
  5572. other package(s) removed at the same time, you must add the name of
  5573. the other package to the :term:`RCONFLICTS` variable.
  5574. As with all package-controlling variables, you must use this variable
  5575. in conjunction with a package name override. Here is an example::
  5576. RREPLACES:${PN} = "other_package_being_replaced"
  5577. BitBake, which the OpenEmbedded build system uses, supports
  5578. specifying versioned replacements. Although the syntax varies
  5579. depending on the packaging format, BitBake hides these differences
  5580. from you. Here is the general syntax to specify versions with the
  5581. :term:`RREPLACES` variable::
  5582. RREPLACES:${PN} = "package (operator version)"
  5583. For ``operator``, you can specify the following:
  5584. - =
  5585. - <
  5586. - >
  5587. - <=
  5588. - >=
  5589. For example, the following sets up a replacement using version 1.2
  5590. or greater of the package ``foo``::
  5591. RREPLACES:${PN} = "foo (>= 1.2)"
  5592. :term:`RSUGGESTS`
  5593. A list of additional packages that you can suggest for installation
  5594. by the package manager at the time a package is installed. Not all
  5595. package managers support this functionality.
  5596. As with all package-controlling variables, you must always use this
  5597. variable in conjunction with a package name override. Here is an
  5598. example::
  5599. RSUGGESTS:${PN} = "useful_package another_package"
  5600. :term:`RUST_CHANNEL`
  5601. Specifies which version of Rust to build - "stable", "beta" or "nightly".
  5602. The default value is "stable". Set this at your own risk, as values other
  5603. than "stable" are not guaranteed to work at a given time.
  5604. :term:`S`
  5605. The location in the :term:`Build Directory` where
  5606. unpacked recipe source code resides. By default, this directory is
  5607. ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
  5608. where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe
  5609. version. If the source tarball extracts the code to a directory named
  5610. anything other than ``${BPN}-${PV}``, or if the source code is
  5611. fetched from an SCM such as Git or Subversion, then you must set
  5612. :term:`S` in the recipe so that the OpenEmbedded build system knows where
  5613. to find the unpacked source.
  5614. As an example, assume a :term:`Source Directory`
  5615. top-level folder named ``poky`` and a default :term:`Build Directory` at
  5616. ``poky/build``. In this case, the work directory the build system
  5617. uses to keep the unpacked recipe for ``db`` is the following::
  5618. poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
  5619. The unpacked source code resides in the ``db-5.1.19`` folder.
  5620. This next example assumes a Git repository. By default, Git
  5621. repositories are cloned to ``${WORKDIR}/git`` during
  5622. :ref:`ref-tasks-fetch`. Since this path is different
  5623. from the default value of :term:`S`, you must set it specifically so the
  5624. source can be located::
  5625. SRC_URI = "git://path/to/repo.git;branch=main"
  5626. S = "${WORKDIR}/git"
  5627. :term:`SANITY_REQUIRED_UTILITIES`
  5628. Specifies a list of command-line utilities that should be checked for
  5629. during the initial sanity checking process when running BitBake. If
  5630. any of the utilities are not installed on the build host, then
  5631. BitBake immediately exits with an error.
  5632. :term:`SANITY_TESTED_DISTROS`
  5633. A list of the host distribution identifiers that the build system has
  5634. been tested against. Identifiers consist of the host distributor ID
  5635. followed by the release, as reported by the ``lsb_release`` tool or
  5636. as read from ``/etc/lsb-release``. Separate the list items with
  5637. explicit newline characters (``\n``). If :term:`SANITY_TESTED_DISTROS` is
  5638. not empty and the current value of
  5639. :term:`NATIVELSBSTRING` does not appear in the
  5640. list, then the build system reports a warning that indicates the
  5641. current host distribution has not been tested as a build host.
  5642. :term:`SDK_ARCH`
  5643. The target architecture for the SDK. Typically, you do not directly
  5644. set this variable. Instead, use :term:`SDKMACHINE`.
  5645. :term:`SDK_ARCHIVE_TYPE`
  5646. Specifies the type of archive to create for the SDK. Valid values:
  5647. - ``tar.xz`` (default)
  5648. - ``zip``
  5649. Only one archive type can be specified.
  5650. :term:`SDK_BUILDINFO_FILE`
  5651. When using the :ref:`ref-classes-image-buildinfo` class,
  5652. specifies the file in the SDK to write the build information into. The
  5653. default value is "``/buildinfo``".
  5654. :term:`SDK_CUSTOM_TEMPLATECONF`
  5655. When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to
  5656. "1" and a ``conf/templateconf.cfg`` file exists in the :term:`Build Directory`
  5657. (:term:`TOPDIR`) then this will be copied into the SDK.
  5658. :term:`SDK_DEPLOY`
  5659. The directory set up and used by the
  5660. :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which the
  5661. SDK is deployed. The :ref:`populate_sdk_base <ref-classes-populate-sdk>`
  5662. class defines :term:`SDK_DEPLOY` as follows::
  5663. SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
  5664. :term:`SDK_DIR`
  5665. The parent directory used by the OpenEmbedded build system when
  5666. creating SDK output. The
  5667. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines
  5668. the variable as follows::
  5669. SDK_DIR = "${WORKDIR}/sdk"
  5670. .. note::
  5671. The :term:`SDK_DIR` directory is a temporary directory as it is part of
  5672. :term:`WORKDIR`. The final output directory is :term:`SDK_DEPLOY`.
  5673. :term:`SDK_EXT_TYPE`
  5674. Controls whether or not shared state artifacts are copied into the
  5675. extensible SDK. The default value of "full" copies all of the
  5676. required shared state artifacts into the extensible SDK. The value
  5677. "minimal" leaves these artifacts out of the SDK.
  5678. .. note::
  5679. If you set the variable to "minimal", you need to ensure
  5680. :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the
  5681. artifacts to be fetched as needed.
  5682. :term:`SDK_HOST_MANIFEST`
  5683. The manifest file for the host part of the SDK. This file lists all
  5684. the installed packages that make up the host part of the SDK. The
  5685. file contains package information on a line-per-package basis as
  5686. follows::
  5687. packagename packagearch version
  5688. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class
  5689. defines the manifest file as follows::
  5690. SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest"
  5691. The location is derived using the :term:`SDK_DEPLOY` and
  5692. :term:`TOOLCHAIN_OUTPUTNAME` variables.
  5693. :term:`SDK_INCLUDE_PKGDATA`
  5694. When set to "1", specifies to include the packagedata for all recipes
  5695. in the "world" target in the extensible SDK. Including this data
  5696. allows the ``devtool search`` command to find these recipes in search
  5697. results, as well as allows the ``devtool add`` command to map
  5698. dependencies more effectively.
  5699. .. note::
  5700. Enabling the :term:`SDK_INCLUDE_PKGDATA`
  5701. variable significantly increases build time because all of world
  5702. needs to be built. Enabling the variable also slightly increases
  5703. the size of the extensible SDK.
  5704. :term:`SDK_INCLUDE_TOOLCHAIN`
  5705. When set to "1", specifies to include the toolchain in the extensible
  5706. SDK. Including the toolchain is useful particularly when
  5707. :term:`SDK_EXT_TYPE` is set to "minimal" to keep
  5708. the SDK reasonably small but you still want to provide a usable
  5709. toolchain. For example, suppose you want to use the toolchain from an
  5710. IDE or from other tools and you do not want to perform additional
  5711. steps to install the toolchain.
  5712. The :term:`SDK_INCLUDE_TOOLCHAIN` variable defaults to "0" if
  5713. :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if
  5714. :term:`SDK_EXT_TYPE` is set to "full".
  5715. :term:`SDK_NAME`
  5716. The base name for SDK output files. The default value (as set in
  5717. ``meta-poky/conf/distro/poky.conf``) is derived from the
  5718. :term:`DISTRO`,
  5719. :term:`TCLIBC`,
  5720. :term:`SDKMACHINE`,
  5721. :term:`IMAGE_BASENAME`,
  5722. :term:`TUNE_PKGARCH`, and
  5723. :term:`MACHINE` variables::
  5724. SDK_NAME = "${DISTRO}-${TCLIBC}-${SDKMACHINE}-${IMAGE_BASENAME}-${TUNE_PKGARCH}-${MACHINE}"
  5725. :term:`SDK_OS`
  5726. Specifies the operating system for which the SDK will be built. The
  5727. default value is the value of :term:`BUILD_OS`.
  5728. :term:`SDK_OUTPUT`
  5729. The location used by the OpenEmbedded build system when creating SDK
  5730. output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
  5731. class defines the variable as follows::
  5732. SDK_DIR = "${WORKDIR}/sdk"
  5733. SDK_OUTPUT = "${SDK_DIR}/image"
  5734. SDK_DEPLOY = "${DEPLOY_DIR}/sdk"
  5735. .. note::
  5736. The :term:`SDK_OUTPUT` directory is a temporary directory as it is part of
  5737. :term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is
  5738. :term:`SDK_DEPLOY`.
  5739. :term:`SDK_PACKAGE_ARCHS`
  5740. Specifies a list of architectures compatible with the SDK machine.
  5741. This variable is set automatically and should not normally be
  5742. hand-edited. Entries are separated using spaces and listed in order
  5743. of priority. The default value for :term:`SDK_PACKAGE_ARCHS` is "all any
  5744. noarch ${SDK_ARCH}-${SDKPKGSUFFIX}".
  5745. :term:`SDK_POSTPROCESS_COMMAND`
  5746. Specifies a list of functions to call once the OpenEmbedded build
  5747. system creates the SDK. You can specify functions separated by
  5748. spaces:
  5749. SDK_POSTPROCESS_COMMAND += "function"
  5750. If you need to pass an SDK path to a command within a function, you
  5751. can use ``${SDK_DIR}``, which points to the parent directory used by
  5752. the OpenEmbedded build system when creating SDK output. See the
  5753. :term:`SDK_DIR` variable for more information.
  5754. :term:`SDK_PREFIX`
  5755. The toolchain binary prefix used for
  5756. :ref:`ref-classes-nativesdk` recipes. The
  5757. OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the
  5758. :term:`TARGET_PREFIX` when building
  5759. ``nativesdk`` recipes. The default value is "${SDK_SYS}-".
  5760. :term:`SDK_RECRDEP_TASKS`
  5761. A list of shared state tasks added to the extensible SDK. By default,
  5762. the following tasks are added:
  5763. - :ref:`ref-tasks-populate_lic`
  5764. - :ref:`ref-tasks-package_qa`
  5765. - :ref:`ref-tasks-populate_sysroot`
  5766. - :ref:`ref-tasks-deploy`
  5767. Despite the default value of "" for the
  5768. :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added
  5769. to the SDK. To specify tasks beyond these four, you need to use the
  5770. :term:`SDK_RECRDEP_TASKS` variable (e.g. you are defining additional
  5771. tasks that are needed in order to build
  5772. :term:`SDK_TARGETS`).
  5773. :term:`SDK_SYS`
  5774. Specifies the system, including the architecture and the operating
  5775. system, for which the SDK will be built.
  5776. The OpenEmbedded build system automatically sets this variable based
  5777. on :term:`SDK_ARCH`,
  5778. :term:`SDK_VENDOR`, and
  5779. :term:`SDK_OS`. You do not need to set the :term:`SDK_SYS`
  5780. variable yourself.
  5781. :term:`SDK_TARGET_MANIFEST`
  5782. The manifest file for the target part of the SDK. This file lists all
  5783. the installed packages that make up the target part of the SDK. The
  5784. file contains package information on a line-per-package basis as
  5785. follows::
  5786. packagename packagearch version
  5787. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class
  5788. defines the manifest file as follows::
  5789. SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest"
  5790. The location is derived using the :term:`SDK_DEPLOY` and
  5791. :term:`TOOLCHAIN_OUTPUTNAME` variables.
  5792. :term:`SDK_TARGETS`
  5793. A list of targets to install from shared state as part of the
  5794. standard or extensible SDK installation. The default value is "${PN}"
  5795. (i.e. the image from which the SDK is built).
  5796. The :term:`SDK_TARGETS` variable is an internal variable and typically
  5797. would not be changed.
  5798. :term:`SDK_TITLE`
  5799. The title to be printed when running the SDK installer. By default,
  5800. this title is based on the :term:`DISTRO_NAME` or
  5801. :term:`DISTRO` variable and is set in the
  5802. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class as
  5803. follows::
  5804. SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK"
  5805. For the default distribution "poky",
  5806. :term:`SDK_TITLE` is set to "Poky (Yocto Project Reference Distro)".
  5807. For information on how to change this default title, see the
  5808. ":ref:`sdk-manual/appendix-customizing:changing the extensible sdk installer title`"
  5809. section in the Yocto Project Application Development and the
  5810. Extensible Software Development Kit (eSDK) manual.
  5811. :term:`SDK_TOOLCHAIN_LANGS`
  5812. Specifies programming languages to support in the SDK, as a
  5813. space-separated list. Currently supported items are ``rust`` and ``go``.
  5814. :term:`SDK_UPDATE_URL`
  5815. An optional URL for an update server for the extensible SDK. If set,
  5816. the value is used as the default update server when running
  5817. ``devtool sdk-update`` within the extensible SDK.
  5818. :term:`SDK_VENDOR`
  5819. Specifies the name of the SDK vendor.
  5820. :term:`SDK_VERSION`
  5821. Specifies the version of the SDK. The Poky distribution configuration file
  5822. (``/meta-poky/conf/distro/poky.conf``) sets the default
  5823. :term:`SDK_VERSION` as follows::
  5824. SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${METADATA_REVISION}', 'snapshot')}"
  5825. For additional information, see the
  5826. :term:`DISTRO_VERSION` and
  5827. :term:`METADATA_REVISION` variables.
  5828. :term:`SDK_ZIP_OPTIONS`
  5829. Specifies extra options to pass to the ``zip`` command when zipping the SDK
  5830. (i.e. when :term:`SDK_ARCHIVE_TYPE` is set to "zip"). The default value is
  5831. "-y".
  5832. :term:`SDKEXTPATH`
  5833. The default installation directory for the Extensible SDK. By
  5834. default, this directory is based on the :term:`DISTRO`
  5835. variable and is set in the
  5836. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class as
  5837. follows::
  5838. SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
  5839. For the
  5840. default distribution "poky", the :term:`SDKEXTPATH` is set to "poky_sdk".
  5841. For information on how to change this default directory, see the
  5842. ":ref:`sdk-manual/appendix-customizing:changing the default sdk installation directory`"
  5843. section in the Yocto Project Application Development and the
  5844. Extensible Software Development Kit (eSDK) manual.
  5845. :term:`SDKIMAGE_FEATURES`
  5846. Equivalent to :term:`IMAGE_FEATURES`. However, this variable applies to
  5847. the SDK generated from an image using the following command::
  5848. $ bitbake -c populate_sdk imagename
  5849. :term:`SDKMACHINE`
  5850. The machine for which the SDK is built. In other words, the SDK is built
  5851. such that it runs on the target you specify with the :term:`SDKMACHINE`
  5852. value. The value points to a corresponding ``.conf`` file under
  5853. ``conf/machine-sdk/`` in the enabled layers, for example ``aarch64``,
  5854. ``i586``, ``i686``, ``ppc64``, ``ppc64le``, and ``x86_64`` are
  5855. :oe_git:`available in OpenEmbedded-Core </openembedded-core/tree/meta/conf/machine-sdk>`.
  5856. The variable defaults to :term:`BUILD_ARCH` so that SDKs are built for the
  5857. architecture of the build machine.
  5858. .. note::
  5859. You cannot set the :term:`SDKMACHINE`
  5860. variable in your distribution configuration file. If you do, the
  5861. configuration will not take effect.
  5862. :term:`SDKPATH`
  5863. Defines the path used to collect the SDK components and build the
  5864. installer.
  5865. :term:`SDKPATHINSTALL`
  5866. Defines the path offered to the user for installation of the SDK that
  5867. is generated by the OpenEmbedded build system. The path appears as
  5868. the default location for installing the SDK when you run the SDK's
  5869. installation script. You can override the offered path when you run
  5870. the script.
  5871. :term:`SDKTARGETSYSROOT`
  5872. The full path to the sysroot used for cross-compilation within an SDK
  5873. as it will be when installed into the default
  5874. :term:`SDKPATHINSTALL`.
  5875. :term:`SECTION`
  5876. The section in which packages should be categorized. Package
  5877. management utilities can make use of this variable.
  5878. :term:`SELECTED_OPTIMIZATION`
  5879. Specifies the optimization flags passed to the C compiler when
  5880. building for the target. The flags are passed through the default
  5881. value of the :term:`TARGET_CFLAGS` variable.
  5882. The :term:`SELECTED_OPTIMIZATION` variable takes the value of
  5883. :term:`FULL_OPTIMIZATION` unless :term:`DEBUG_BUILD` = "1", in which
  5884. case the value of :term:`DEBUG_OPTIMIZATION` is used.
  5885. :term:`SERIAL_CONSOLES`
  5886. Defines a serial console (TTY) to enable using
  5887. :wikipedia:`getty <Getty_(Unix)>`. Provide a value that specifies the
  5888. baud rate followed by the TTY device name separated by a semicolon.
  5889. Use spaces to separate multiple devices::
  5890. SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1"
  5891. :term:`SETUPTOOLS_BUILD_ARGS`
  5892. When used by recipes that inherit the :ref:`ref-classes-setuptools3`
  5893. class, this variable can be used to specify additional arguments to be
  5894. passed to ``setup.py build`` in the ``setuptools3_do_compile()`` task.
  5895. :term:`SETUPTOOLS_INSTALL_ARGS`
  5896. When used by recipes that inherit the :ref:`ref-classes-setuptools3`
  5897. class, this variable can be used to specify additional arguments to be
  5898. passed to ``setup.py install`` in the ``setuptools3_do_install()`` task.
  5899. :term:`SETUPTOOLS_SETUP_PATH`
  5900. When used by recipes that inherit the :ref:`ref-classes-setuptools3`
  5901. class, this variable should be used to specify the directory in which
  5902. the ``setup.py`` file is located if it is not at the root of the source
  5903. tree (as specified by :term:`S`). For example, in a recipe where the
  5904. sources are fetched from a Git repository and ``setup.py`` is in a
  5905. ``python/pythonmodule`` subdirectory, you would have this::
  5906. S = "${WORKDIR}/git"
  5907. SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule"
  5908. :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
  5909. A list of recipe dependencies that should not be used to determine
  5910. signatures of tasks from one recipe when they depend on tasks from
  5911. another recipe. For example::
  5912. SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
  5913. In the previous example, ``intone`` depends on ``mplayer2``.
  5914. You can use the special token ``"*"`` on the left-hand side of the
  5915. dependency to match all recipes except the one on the right-hand
  5916. side. Here is an example::
  5917. SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native"
  5918. In the previous example, all recipes except ``quilt-native`` ignore
  5919. task signatures from the ``quilt-native`` recipe when determining
  5920. their task signatures.
  5921. Use of this variable is one mechanism to remove dependencies that
  5922. affect task signatures and thus force rebuilds when a recipe changes.
  5923. .. note::
  5924. If you add an inappropriate dependency for a recipe relationship,
  5925. the software might break during runtime if the interface of the
  5926. second recipe was changed after the first recipe had been built.
  5927. :term:`SIGGEN_EXCLUDERECIPES_ABISAFE`
  5928. A list of recipes that are completely stable and will never change.
  5929. The ABI for the recipes in the list are presented by output from the
  5930. tasks run to build the recipe. Use of this variable is one way to
  5931. remove dependencies from one recipe on another that affect task
  5932. signatures and thus force rebuilds when the recipe changes.
  5933. .. note::
  5934. If you add an inappropriate variable to this list, the software
  5935. might break at runtime if the interface of the recipe was changed
  5936. after the other had been built.
  5937. :term:`SITEINFO_BITS`
  5938. Specifies the number of bits for the target system CPU. The value
  5939. should be either "32" or "64".
  5940. :term:`SITEINFO_ENDIANNESS`
  5941. Specifies the endian byte order of the target system. The value
  5942. should be either "le" for little-endian or "be" for big-endian.
  5943. :term:`SKIP_FILEDEPS`
  5944. Enables removal of all files from the "Provides" section of an RPM
  5945. package. Removal of these files is required for packages containing
  5946. prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``.
  5947. To enable file removal, set the variable to "1" in your
  5948. ``conf/local.conf`` configuration file in your:
  5949. :term:`Build Directory`::
  5950. SKIP_FILEDEPS = "1"
  5951. :term:`SKIP_RECIPE`
  5952. Used to prevent the OpenEmbedded build system from building a given
  5953. recipe. Specify the :term:`PN` value as a variable flag (``varflag``)
  5954. and provide a reason, which will be reported when attempting to
  5955. build the recipe.
  5956. To prevent a recipe from being built, use the :term:`SKIP_RECIPE`
  5957. variable in your ``local.conf`` file or distribution configuration.
  5958. Here is an example which prevents ``myrecipe`` from being built::
  5959. SKIP_RECIPE[myrecipe] = "Not supported by our organization."
  5960. :term:`SOC_FAMILY`
  5961. A colon-separated list grouping together machines based upon the same
  5962. family of SoC (System On Chip). You typically set this variable in a
  5963. common ``.inc`` file that you include in the configuration files of all
  5964. the machines.
  5965. .. note::
  5966. You must include ``conf/machine/include/soc-family.inc`` for this
  5967. variable to appear in :term:`MACHINEOVERRIDES`.
  5968. :term:`SOLIBS`
  5969. Defines the suffix for shared libraries used on the target platform.
  5970. By default, this suffix is ".so.*" for all Linux-based systems and is
  5971. defined in the ``meta/conf/bitbake.conf`` configuration file.
  5972. You will see this variable referenced in the default values of
  5973. ``FILES:${PN}``.
  5974. :term:`SOLIBSDEV`
  5975. Defines the suffix for the development symbolic link (symlink) for
  5976. shared libraries on the target platform. By default, this suffix is
  5977. ".so" for Linux-based systems and is defined in the
  5978. ``meta/conf/bitbake.conf`` configuration file.
  5979. You will see this variable referenced in the default values of
  5980. ``FILES:${PN}-dev``.
  5981. :term:`SOURCE_DATE_EPOCH`
  5982. This defines a date expressed in number of seconds since
  5983. the UNIX EPOCH (01 Jan 1970 00:00:00 UTC), which is used by
  5984. multiple build systems to force a timestamp in built binaries.
  5985. Many upstream projects already support this variable.
  5986. You will find more details in the `official specifications
  5987. <https://reproducible-builds.org/specs/source-date-epoch/>`__.
  5988. A value for each recipe is computed from the sources by
  5989. :oe_git:`meta/lib/oe/reproducible.py </openembedded-core/tree/meta/lib/oe/reproducible.py>`.
  5990. If a recipe wishes to override the default behavior, it should set its
  5991. own :term:`SOURCE_DATE_EPOCH` value::
  5992. SOURCE_DATE_EPOCH = "1613559011"
  5993. :term:`SOURCE_MIRROR_FETCH`
  5994. When you are fetching files to create a mirror of sources (i.e.
  5995. creating a source mirror), setting :term:`SOURCE_MIRROR_FETCH` to "1" in
  5996. your ``local.conf`` configuration file ensures the source for all
  5997. recipes are fetched regardless of whether or not a recipe is
  5998. compatible with the configuration. A recipe is considered
  5999. incompatible with the currently configured machine when either or
  6000. both the :term:`COMPATIBLE_MACHINE`
  6001. variable and :term:`COMPATIBLE_HOST` variables
  6002. specify compatibility with a machine other than that of the current
  6003. machine or host.
  6004. .. note::
  6005. Do not set the :term:`SOURCE_MIRROR_FETCH`
  6006. variable unless you are creating a source mirror. In other words,
  6007. do not set the variable during a normal build.
  6008. :term:`SOURCE_MIRROR_URL`
  6009. Defines your own :term:`PREMIRRORS` from which to
  6010. first fetch source before attempting to fetch from the upstream
  6011. specified in :term:`SRC_URI`.
  6012. To use this variable, you must globally inherit the
  6013. :ref:`ref-classes-own-mirrors` class and then provide
  6014. the URL to your mirrors. Here is the general syntax::
  6015. INHERIT += "own-mirrors"
  6016. SOURCE_MIRROR_URL = "http://example.com/my_source_mirror"
  6017. .. note::
  6018. You can specify only a single URL in :term:`SOURCE_MIRROR_URL`.
  6019. :term:`SPDX_ARCHIVE_PACKAGED`
  6020. This option allows to add to :term:`SPDX` output compressed archives
  6021. of the files in the generated target packages.
  6022. Such archives are available in
  6023. ``tmp/deploy/spdx/MACHINE/packages/packagename.tar.zst``
  6024. under the :term:`Build Directory`.
  6025. Enable this option as follows::
  6026. SPDX_ARCHIVE_PACKAGED = "1"
  6027. According to our tests on release 4.1 "langdale", building
  6028. ``core-image-minimal`` for the ``qemux86-64`` machine, enabling this
  6029. option multiplied the size of the ``tmp/deploy/spdx`` directory by a
  6030. factor of 13 (+1.6 GiB for this image), compared to just using the
  6031. :ref:`ref-classes-create-spdx` class with no option.
  6032. Note that this option doesn't increase the size of :term:`SPDX`
  6033. files in ``tmp/deploy/images/MACHINE``.
  6034. :term:`SPDX_ARCHIVE_SOURCES`
  6035. This option allows to add to :term:`SPDX` output compressed archives
  6036. of the sources for packages installed on the target. It currently
  6037. only works when :term:`SPDX_INCLUDE_SOURCES` is set.
  6038. This is one way of fulfilling "source code access" license
  6039. requirements.
  6040. Such source archives are available in
  6041. ``tmp/deploy/spdx/MACHINE/recipes/recipe-packagename.tar.zst``
  6042. under the :term:`Build Directory`.
  6043. Enable this option as follows::
  6044. SPDX_INCLUDE_SOURCES = "1"
  6045. SPDX_ARCHIVE_SOURCES = "1"
  6046. According to our tests on release 4.1 "langdale", building
  6047. ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
  6048. these options multiplied the size of the ``tmp/deploy/spdx``
  6049. directory by a factor of 11 (+1.4 GiB for this image),
  6050. compared to just using the :ref:`ref-classes-create-spdx`
  6051. class with no option.
  6052. Note that using this option only marginally increases the size
  6053. of the :term:`SPDX` output in ``tmp/deploy/images/MACHINE/``
  6054. (+ 0.07\% with the tested image), compared to just enabling
  6055. :term:`SPDX_INCLUDE_SOURCES`.
  6056. :term:`SPDX_CUSTOM_ANNOTATION_VARS`
  6057. This option allows to associate `SPDX annotations
  6058. <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe,
  6059. using the values of variables in the recipe::
  6060. ANNOTATION1 = "First annotation for recipe"
  6061. ANNOTATION2 = "Second annotation for recipe"
  6062. SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2"
  6063. This will add a new block to the recipe ``.sdpx.json`` output::
  6064. "annotations": [
  6065. {
  6066. "annotationDate": "2023-04-18T08:32:12Z",
  6067. "annotationType": "OTHER",
  6068. "annotator": "Tool: oe-spdx-creator - 1.0",
  6069. "comment": "ANNOTATION1=First annotation for recipe"
  6070. },
  6071. {
  6072. "annotationDate": "2023-04-18T08:32:12Z",
  6073. "annotationType": "OTHER",
  6074. "annotator": "Tool: oe-spdx-creator - 1.0",
  6075. "comment": "ANNOTATION2=Second annotation for recipe"
  6076. }
  6077. ],
  6078. :term:`SPDX_INCLUDE_SOURCES`
  6079. This option allows to add a description of the source files used to build
  6080. the host tools and the target packages, to the ``spdx.json`` files in
  6081. ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`.
  6082. As a consequence, the ``spdx.json`` files under the ``by-namespace`` and
  6083. ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also
  6084. modified to include references to such source file descriptions.
  6085. Enable this option as follows::
  6086. SPDX_INCLUDE_SOURCES = "1"
  6087. According to our tests on release 4.1 "langdale", building
  6088. ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
  6089. this option multiplied the total size of the ``tmp/deploy/spdx``
  6090. directory by a factor of 3 (+291 MiB for this image),
  6091. and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in
  6092. ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this
  6093. image), compared to just using the :ref:`ref-classes-create-spdx` class
  6094. with no option.
  6095. :term:`SPDX_PRETTY`
  6096. This option makes the SPDX output more human-readable, using
  6097. identation and newlines, instead of the default output in a
  6098. single line::
  6099. SPDX_PRETTY = "1"
  6100. The generated SPDX files are approximately 20% bigger, but
  6101. this option is recommended if you want to inspect the SPDX
  6102. output files with a text editor.
  6103. :term:`SPDXLICENSEMAP`
  6104. Maps commonly used license names to their SPDX counterparts found in
  6105. ``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP`
  6106. mappings, see the ``meta/conf/licenses.conf`` file.
  6107. For additional information, see the :term:`LICENSE`
  6108. variable.
  6109. :term:`SPECIAL_PKGSUFFIX`
  6110. A list of prefixes for :term:`PN` used by the OpenEmbedded
  6111. build system to create variants of recipes or packages. The list
  6112. specifies the prefixes to strip off during certain circumstances such
  6113. as the generation of the :term:`BPN` variable.
  6114. :term:`SPL_BINARY`
  6115. The file type for the Secondary Program Loader (SPL). Some devices
  6116. use an SPL from which to boot (e.g. the BeagleBone development
  6117. board). For such cases, you can declare the file type of the SPL
  6118. binary in the ``u-boot.inc`` include file, which is used in the
  6119. U-Boot recipe.
  6120. The SPL file type is set to "null" by default in the ``u-boot.inc``
  6121. file as follows::
  6122. # Some versions of u-boot build an SPL (Second Program Loader) image that
  6123. # should be packaged along with the u-boot binary as well as placed in the
  6124. # deploy directory. For those versions they can set the following variables
  6125. # to allow packaging the SPL.
  6126. SPL_BINARY ?= ""
  6127. SPL_BINARYNAME ?= "${@os.path.basename(d.getVar("SPL_BINARY"))}"
  6128. SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}"
  6129. SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}"
  6130. The :term:`SPL_BINARY` variable helps form
  6131. various ``SPL_*`` variables used by the OpenEmbedded build system.
  6132. See the BeagleBone machine configuration example in the
  6133. ":ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script`"
  6134. section in the Yocto Project Board Support Package Developer's Guide
  6135. for additional information.
  6136. :term:`SPL_MKIMAGE_DTCOPTS`
  6137. Options for the device tree compiler passed to ``mkimage -D`` feature
  6138. while creating a FIT image with the :ref:`ref-classes-uboot-sign`
  6139. class. If :term:`SPL_MKIMAGE_DTCOPTS` is not set then the
  6140. :ref:`ref-classes-uboot-sign` class will not pass the ``-D`` option
  6141. to ``mkimage``.
  6142. The default value is set to "" by the :ref:`ref-classes-uboot-config`
  6143. class.
  6144. :term:`SPL_SIGN_ENABLE`
  6145. Enable signing of the U-Boot FIT image. The default value is "0".
  6146. This variable is used by the :ref:`ref-classes-uboot-sign` class.
  6147. :term:`SPL_SIGN_KEYDIR`
  6148. Location of the directory containing the RSA key and certificate used for
  6149. signing the U-Boot FIT image, used by the :ref:`ref-classes-uboot-sign`
  6150. class.
  6151. :term:`SPL_SIGN_KEYNAME`
  6152. The name of keys used by the :ref:`ref-classes-kernel-fitimage` class
  6153. for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR`
  6154. directory. If we have for example a ``dev.key`` key and a ``dev.crt``
  6155. certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
  6156. have to set :term:`SPL_SIGN_KEYNAME` to ``dev``.
  6157. :term:`SPLASH`
  6158. This variable, used by the :ref:`ref-classes-image` class, allows
  6159. to choose splashscreen applications. Set it to the names of packages
  6160. for such applications to use. This variable is set by default to
  6161. ``psplash``.
  6162. :term:`SPLASH_IMAGES`
  6163. This variable, used by the ``psplash`` recipe, allows to customize
  6164. the default splashscreen image.
  6165. Specified images in PNG format are converted to ``.h`` files by the recipe,
  6166. and are included in the ``psplash`` binary, so you won't find them in
  6167. the root filesystem.
  6168. To make such a change, it is recommended to customize the
  6169. ``psplash`` recipe in a custom layer. Here is an example structure for
  6170. an ``ACME`` board::
  6171. meta-acme/recipes-core/psplash
  6172. ├── files
  6173. │   └── logo-acme.png
  6174. └── psplash_%.bbappend
  6175. And here are the contents of the ``psplash_%.bbappend`` file in
  6176. this example::
  6177. SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default"
  6178. FILESEXTRAPATHS:prepend := "${THISDIR}/files:"
  6179. You could even add specific configuration options for ``psplash``,
  6180. for example::
  6181. EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen"
  6182. For information on append files, see the
  6183. ":ref:`dev-manual/layers:appending other layers metadata with your layer`"
  6184. section.
  6185. :term:`SRCREV_FORMAT`
  6186. See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual.
  6187. :term:`SRC_URI`
  6188. See the BitBake manual for the initial description for this variable:
  6189. :term:`bitbake:SRC_URI`.
  6190. The following features are added by OpenEmbedded and the Yocto Project.
  6191. There are standard and recipe-specific options. Here are standard ones:
  6192. - ``apply`` --- whether to apply the patch or not. The default
  6193. action is to apply the patch.
  6194. - ``striplevel`` --- which striplevel to use when applying the
  6195. patch. The default level is 1.
  6196. - ``patchdir`` --- specifies the directory in which the patch should
  6197. be applied. The default is ``${``\ :term:`S`\ ``}``.
  6198. Here are options specific to recipes building code from a revision
  6199. control system:
  6200. - ``mindate`` --- apply the patch only if
  6201. :term:`SRCDATE` is equal to or greater than
  6202. ``mindate``.
  6203. - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later
  6204. than ``maxdate``.
  6205. - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or
  6206. greater than ``minrev``.
  6207. - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later
  6208. than ``maxrev``.
  6209. - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to
  6210. ``rev``.
  6211. - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to
  6212. ``rev``.
  6213. .. note::
  6214. If you want the build system to pick up files specified through
  6215. a :term:`SRC_URI` statement from your append file, you need to be
  6216. sure to extend the :term:`FILESPATH` variable by also using the
  6217. :term:`FILESEXTRAPATHS` variable from within your append file.
  6218. :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
  6219. By default, the OpenEmbedded build system automatically detects
  6220. whether :term:`SRC_URI` contains files that are machine-specific. If so,
  6221. the build system automatically changes :term:`PACKAGE_ARCH`. Setting this
  6222. variable to "0" disables this behavior.
  6223. :term:`SRCDATE`
  6224. The date of the source code used to build the package. This variable
  6225. applies only if the source was fetched from a Source Code Manager
  6226. (SCM).
  6227. :term:`SRCPV`
  6228. Returns the version string of the current package. This string is
  6229. used to help define the value of :term:`PV`.
  6230. The :term:`SRCPV` variable is defined in the ``meta/conf/bitbake.conf``
  6231. configuration file in the :term:`Source Directory` as
  6232. follows::
  6233. SRCPV = "${@bb.fetch2.get_srcrev(d)}"
  6234. Recipes that need to define :term:`PV` do so with the help of the
  6235. :term:`SRCPV`. For example, the ``ofono`` recipe (``ofono_git.bb``)
  6236. located in ``meta/recipes-connectivity`` in the Source Directory
  6237. defines :term:`PV` as follows::
  6238. PV = "0.12-git${SRCPV}"
  6239. :term:`SRCREV`
  6240. The revision of the source code used to build the package. This
  6241. variable applies to Subversion, Git, Mercurial, and Bazaar only. Note
  6242. that if you want to build a fixed revision and you want to avoid
  6243. performing a query on the remote repository every time BitBake parses
  6244. your recipe, you should specify a :term:`SRCREV` that is a full revision
  6245. identifier (e.g. the full SHA hash in git) and not just a tag.
  6246. .. note::
  6247. For information on limitations when inheriting the latest revision
  6248. of software using :term:`SRCREV`, see the :term:`AUTOREV` variable
  6249. description and the
  6250. ":ref:`dev-manual/packages:automatically incrementing a package version number`"
  6251. section, which is in the Yocto Project Development Tasks Manual.
  6252. :term:`SRCTREECOVEREDTASKS`
  6253. A list of tasks that are typically not relevant (and therefore skipped)
  6254. when building using the :ref:`ref-classes-externalsrc`
  6255. class. The default value as set in that class file is the set of tasks
  6256. that are rarely needed when using external source::
  6257. SRCTREECOVEREDTASKS ?= "do_patch do_unpack do_fetch"
  6258. The notable exception is when processing external kernel source as
  6259. defined in the :ref:`ref-classes-kernel-yocto` class file (formatted for
  6260. aesthetics)::
  6261. SRCTREECOVEREDTASKS += "\
  6262. do_validate_branches \
  6263. do_kernel_configcheck \
  6264. do_kernel_checkout \
  6265. do_fetch \
  6266. do_unpack \
  6267. do_patch \
  6268. "
  6269. See the associated :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD`
  6270. variables for more information.
  6271. :term:`SSTATE_DIR`
  6272. The directory for the shared state cache.
  6273. :term:`SSTATE_EXCLUDEDEPS_SYSROOT`
  6274. This variable allows to specify indirect dependencies to exclude
  6275. from sysroots, for example to avoid the situations when a dependency on
  6276. any ``-native`` recipe will pull in all dependencies of that recipe
  6277. in the recipe sysroot. This behaviour might not always be wanted,
  6278. for example when that ``-native`` recipe depends on build tools
  6279. that are not relevant for the current recipe.
  6280. This way, irrelevant dependencies are ignored, which could have
  6281. prevented the reuse of prebuilt artifacts stored in the Shared
  6282. State Cache.
  6283. :term:`SSTATE_EXCLUDEDEPS_SYSROOT` is evaluated as two regular
  6284. expressions of recipe and dependency to ignore. An example
  6285. is the rule in :oe_git:`meta/conf/layer.conf </openembedded-core/tree/meta/conf/layer.conf>`::
  6286. # Nothing needs to depend on libc-initial
  6287. # base-passwd/shadow-sysroot don't need their dependencies
  6288. SSTATE_EXCLUDEDEPS_SYSROOT += "\
  6289. .*->.*-initial.* \
  6290. .*(base-passwd|shadow-sysroot)->.* \
  6291. "
  6292. The ``->`` substring represents the dependency between
  6293. the two regular expressions.
  6294. :term:`SSTATE_MIRROR_ALLOW_NETWORK`
  6295. If set to "1", allows fetches from mirrors that are specified in
  6296. :term:`SSTATE_MIRRORS` to work even when
  6297. fetching from the network is disabled by setting :term:`BB_NO_NETWORK` to
  6298. "1". Using the :term:`SSTATE_MIRROR_ALLOW_NETWORK` variable is useful if
  6299. you have set :term:`SSTATE_MIRRORS` to point to an internal server for
  6300. your shared state cache, but you want to disable any other fetching
  6301. from the network.
  6302. :term:`SSTATE_MIRRORS`
  6303. Configures the OpenEmbedded build system to search other mirror
  6304. locations for prebuilt cache data objects before building out the
  6305. data. This variable works like fetcher :term:`MIRRORS`
  6306. and :term:`PREMIRRORS` and points to the cache
  6307. locations to check for the shared state (sstate) objects.
  6308. You can specify a filesystem directory or a remote URL such as HTTP
  6309. or FTP. The locations you specify need to contain the shared state
  6310. cache (sstate-cache) results from previous builds. The sstate-cache
  6311. you point to can also be from builds on other machines.
  6312. When pointing to sstate build artifacts on another machine that uses
  6313. a different GCC version for native builds, you must configure
  6314. :term:`SSTATE_MIRRORS` with a regular expression that maps local search
  6315. paths to server paths. The paths need to take into account
  6316. :term:`NATIVELSBSTRING` set by the :ref:`ref-classes-uninative` class.
  6317. For example, the following maps the local search path ``universal-4.9``
  6318. to the server-provided path server_url_sstate_path::
  6319. SSTATE_MIRRORS ?= "file://universal-4.9/(.*) https://server_url_sstate_path/universal-4.8/\1"
  6320. If a mirror uses the same structure as
  6321. :term:`SSTATE_DIR`, you need to add "PATH" at the
  6322. end as shown in the examples below. The build system substitutes the
  6323. correct path within the directory structure::
  6324. SSTATE_MIRRORS ?= "\
  6325. file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \
  6326. file://.* file:///some-local-dir/sstate/PATH"
  6327. The Yocto Project actually shares the cache data objects built by its
  6328. autobuilder::
  6329. SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH"
  6330. As such binary artifacts are built for the generic QEMU machines
  6331. supported by the various Poky releases, they are less likely to be
  6332. reusable in real projects building binaries optimized for a specific
  6333. CPU family.
  6334. :term:`SSTATE_SCAN_FILES`
  6335. Controls the list of files the OpenEmbedded build system scans for
  6336. hardcoded installation paths. The variable uses a space-separated
  6337. list of filenames (not paths) with standard wildcard characters
  6338. allowed.
  6339. During a build, the OpenEmbedded build system creates a shared state
  6340. (sstate) object during the first stage of preparing the sysroots.
  6341. That object is scanned for hardcoded paths for original installation
  6342. locations. The list of files that are scanned for paths is controlled
  6343. by the :term:`SSTATE_SCAN_FILES` variable. Typically, recipes add files
  6344. they want to be scanned to the value of :term:`SSTATE_SCAN_FILES` rather
  6345. than the variable being comprehensively set. The
  6346. :ref:`ref-classes-sstate` class specifies the default list of files.
  6347. For details on the process, see the :ref:`ref-classes-staging` class.
  6348. :term:`STAGING_BASE_LIBDIR_NATIVE`
  6349. Specifies the path to the ``/lib`` subdirectory of the sysroot
  6350. directory for the build host.
  6351. :term:`STAGING_BASELIBDIR`
  6352. Specifies the path to the ``/lib`` subdirectory of the sysroot
  6353. directory for the target for which the current recipe is being built
  6354. (:term:`STAGING_DIR_HOST`).
  6355. :term:`STAGING_BINDIR`
  6356. Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
  6357. directory for the target for which the current recipe is being built
  6358. (:term:`STAGING_DIR_HOST`).
  6359. :term:`STAGING_BINDIR_CROSS`
  6360. Specifies the path to the directory containing binary configuration
  6361. scripts. These scripts provide configuration information for other
  6362. software that wants to make use of libraries or include files
  6363. provided by the software associated with the script.
  6364. .. note::
  6365. This style of build configuration has been largely replaced by
  6366. ``pkg-config``. Consequently, if ``pkg-config`` is supported by the
  6367. library to which you are linking, it is recommended you use
  6368. ``pkg-config`` instead of a provided configuration script.
  6369. :term:`STAGING_BINDIR_NATIVE`
  6370. Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
  6371. directory for the build host.
  6372. :term:`STAGING_DATADIR`
  6373. Specifies the path to the ``/usr/share`` subdirectory of the sysroot
  6374. directory for the target for which the current recipe is being built
  6375. (:term:`STAGING_DIR_HOST`).
  6376. :term:`STAGING_DATADIR_NATIVE`
  6377. Specifies the path to the ``/usr/share`` subdirectory of the sysroot
  6378. directory for the build host.
  6379. :term:`STAGING_DIR`
  6380. Helps construct the ``recipe-sysroots`` directory, which is used
  6381. during packaging.
  6382. For information on how staging for recipe-specific sysroots occurs,
  6383. see the :ref:`ref-tasks-populate_sysroot`
  6384. task, the ":ref:`sdk-manual/extensible:sharing files between recipes`"
  6385. section in the Yocto Project Development Tasks Manual, the
  6386. ":ref:`overview-manual/concepts:configuration, compilation, and staging`"
  6387. section in the Yocto Project Overview and Concepts Manual, and the
  6388. :term:`SYSROOT_DIRS` variable.
  6389. .. note::
  6390. Recipes should never write files directly under the :term:`STAGING_DIR`
  6391. directory because the OpenEmbedded build system manages the
  6392. directory automatically. Instead, files should be installed to
  6393. ``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install`
  6394. task and then the OpenEmbedded build system will stage a subset of
  6395. those files into the sysroot.
  6396. :term:`STAGING_DIR_HOST`
  6397. Specifies the path to the sysroot directory for the system on which
  6398. the component is built to run (the system that hosts the component).
  6399. For most recipes, this sysroot is the one in which that recipe's
  6400. :ref:`ref-tasks-populate_sysroot` task copies
  6401. files. Exceptions include ``-native`` recipes, where the
  6402. :ref:`ref-tasks-populate_sysroot` task instead uses
  6403. :term:`STAGING_DIR_NATIVE`. Depending on
  6404. the type of recipe and the build target, :term:`STAGING_DIR_HOST` can
  6405. have the following values:
  6406. - For recipes building for the target machine, the value is
  6407. "${:term:`STAGING_DIR`}/${:term:`MACHINE`}".
  6408. - For native recipes building for the build host, the value is empty
  6409. given the assumption that when building for the build host, the
  6410. build host's own directories should be used.
  6411. .. note::
  6412. ``-native`` recipes are not installed into host paths like such
  6413. as ``/usr``. Rather, these recipes are installed into
  6414. :term:`STAGING_DIR_NATIVE`. When compiling ``-native`` recipes,
  6415. standard build environment variables such as
  6416. :term:`CPPFLAGS` and
  6417. :term:`CFLAGS` are set up so that both host paths
  6418. and :term:`STAGING_DIR_NATIVE` are searched for libraries and
  6419. headers using, for example, GCC's ``-isystem`` option.
  6420. Thus, the emphasis is that the ``STAGING_DIR*`` variables
  6421. should be viewed as input variables by tasks such as
  6422. :ref:`ref-tasks-configure`,
  6423. :ref:`ref-tasks-compile`, and
  6424. :ref:`ref-tasks-install`. Having the real system
  6425. root correspond to :term:`STAGING_DIR_HOST` makes conceptual sense
  6426. for ``-native`` recipes, as they make use of host headers and
  6427. libraries.
  6428. Check :term:`RECIPE_SYSROOT` and :term:`RECIPE_SYSROOT_NATIVE`.
  6429. :term:`STAGING_DIR_NATIVE`
  6430. Specifies the path to the sysroot directory used when building
  6431. components that run on the build host itself.
  6432. The default value is ``"${RECIPE_SYSROOT_NATIVE}"``,
  6433. check :term:`RECIPE_SYSROOT_NATIVE`.
  6434. :term:`STAGING_DIR_TARGET`
  6435. Specifies the path to the sysroot used for the system for which the
  6436. component generates code. For components that do not generate code,
  6437. which is the majority, :term:`STAGING_DIR_TARGET` is set to match
  6438. :term:`STAGING_DIR_HOST`.
  6439. Some recipes build binaries that can run on the target system but those
  6440. binaries in turn generate code for another different system (e.g.
  6441. :ref:`ref-classes-cross-canadian` recipes). Using terminology from GNU,
  6442. the primary system is referred to as the "HOST" and the secondary, or
  6443. different, system is referred to as the "TARGET". Thus, the binaries
  6444. run on the "HOST" system and generate binaries for the "TARGET"
  6445. system. The :term:`STAGING_DIR_HOST` variable points to the sysroot used
  6446. for the "HOST" system, while :term:`STAGING_DIR_TARGET` points to the
  6447. sysroot used for the "TARGET" system.
  6448. :term:`STAGING_ETCDIR_NATIVE`
  6449. Specifies the path to the ``/etc`` subdirectory of the sysroot
  6450. directory for the build host.
  6451. :term:`STAGING_EXECPREFIXDIR`
  6452. Specifies the path to the ``/usr`` subdirectory of the sysroot
  6453. directory for the target for which the current recipe is being built
  6454. (:term:`STAGING_DIR_HOST`).
  6455. :term:`STAGING_INCDIR`
  6456. Specifies the path to the ``/usr/include`` subdirectory of the
  6457. sysroot directory for the target for which the current recipe being
  6458. built (:term:`STAGING_DIR_HOST`).
  6459. :term:`STAGING_INCDIR_NATIVE`
  6460. Specifies the path to the ``/usr/include`` subdirectory of the
  6461. sysroot directory for the build host.
  6462. :term:`STAGING_KERNEL_BUILDDIR`
  6463. Points to the directory containing the kernel build artifacts.
  6464. Recipes building software that needs to access kernel build artifacts
  6465. (e.g. ``systemtap-uprobes``) can look in the directory specified with
  6466. the :term:`STAGING_KERNEL_BUILDDIR` variable to find these artifacts
  6467. after the kernel has been built.
  6468. :term:`STAGING_KERNEL_DIR`
  6469. The directory with kernel headers that are required to build
  6470. out-of-tree modules.
  6471. :term:`STAGING_LIBDIR`
  6472. Specifies the path to the ``/usr/lib`` subdirectory of the sysroot
  6473. directory for the target for which the current recipe is being built
  6474. (:term:`STAGING_DIR_HOST`).
  6475. :term:`STAGING_LIBDIR_NATIVE`
  6476. Specifies the path to the ``/usr/lib`` subdirectory of the sysroot
  6477. directory for the build host.
  6478. :term:`STAMP`
  6479. Specifies the base path used to create recipe stamp files. The path
  6480. to an actual stamp file is constructed by evaluating this string and
  6481. then appending additional information. Currently, the default
  6482. assignment for :term:`STAMP` as set in the ``meta/conf/bitbake.conf``
  6483. file is::
  6484. STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}"
  6485. For information on how BitBake uses stamp files to determine if a
  6486. task should be rerun, see the
  6487. ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
  6488. section in the Yocto Project Overview and Concepts Manual.
  6489. See :term:`STAMPS_DIR`,
  6490. :term:`MULTIMACH_TARGET_SYS`,
  6491. :term:`PN`, :term:`EXTENDPE`,
  6492. :term:`PV`, and :term:`PR` for related variable
  6493. information.
  6494. :term:`STAMPCLEAN`
  6495. See :term:`bitbake:STAMPCLEAN` in the BitBake manual.
  6496. :term:`STAMPS_DIR`
  6497. Specifies the base directory in which the OpenEmbedded build system
  6498. places stamps. The default directory is ``${TMPDIR}/stamps``.
  6499. :term:`STRIP`
  6500. The minimal command and arguments to run ``strip``, which is used to
  6501. strip symbols.
  6502. :term:`SUMMARY`
  6503. The short (72 characters or less) summary of the binary package for
  6504. packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default,
  6505. :term:`SUMMARY` is used to define the
  6506. :term:`DESCRIPTION` variable if :term:`DESCRIPTION` is
  6507. not set in the recipe.
  6508. :term:`SVNDIR`
  6509. The directory in which files checked out of a Subversion system are
  6510. stored.
  6511. :term:`SYSLINUX_DEFAULT_CONSOLE`
  6512. Specifies the kernel boot default console. If you want to use a
  6513. console other than the default, set this variable in your recipe as
  6514. follows where "X" is the console number you want to use::
  6515. SYSLINUX_DEFAULT_CONSOLE = "console=ttyX"
  6516. The :ref:`ref-classes-syslinux` class initially sets
  6517. this variable to null but then checks for a value later.
  6518. :term:`SYSLINUX_OPTS`
  6519. Lists additional options to add to the syslinux file. You need to set
  6520. this variable in your recipe. If you want to list multiple options,
  6521. separate the options with a semicolon character (``;``).
  6522. The :ref:`ref-classes-syslinux` class uses this variable
  6523. to create a set of options.
  6524. :term:`SYSLINUX_SERIAL`
  6525. Specifies the alternate serial port or turns it off. To turn off
  6526. serial, set this variable to an empty string in your recipe. The
  6527. variable's default value is set in the
  6528. :ref:`ref-classes-syslinux` class as follows::
  6529. SYSLINUX_SERIAL ?= "0 115200"
  6530. The class checks for and uses the variable as needed.
  6531. :term:`SYSLINUX_SERIAL_TTY`
  6532. Specifies the alternate console=tty... kernel boot argument. The
  6533. variable's default value is set in the :ref:`ref-classes-syslinux`
  6534. class as follows::
  6535. SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200"
  6536. The class checks for and uses the variable as needed.
  6537. :term:`SYSLINUX_SPLASH`
  6538. An ``.LSS`` file used as the background for the VGA boot menu when
  6539. you use the boot menu. You need to set this variable in your recipe.
  6540. The :ref:`ref-classes-syslinux` class checks for this
  6541. variable and if found, the OpenEmbedded build system installs the
  6542. splash screen.
  6543. :term:`SYSROOT_DESTDIR`
  6544. Points to the temporary directory under the work directory (default
  6545. "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``")
  6546. where the files populated into the sysroot are assembled during the
  6547. :ref:`ref-tasks-populate_sysroot` task.
  6548. :term:`SYSROOT_DIRS`
  6549. Directories that are staged into the sysroot by the
  6550. :ref:`ref-tasks-populate_sysroot` task. By
  6551. default, the following directories are staged::
  6552. SYSROOT_DIRS = " \
  6553. ${includedir} \
  6554. ${libdir} \
  6555. ${base_libdir} \
  6556. ${nonarch_base_libdir} \
  6557. ${datadir} \
  6558. /sysroot-only \
  6559. "
  6560. :term:`SYSROOT_DIRS_IGNORE`
  6561. Directories that are not staged into the sysroot by the
  6562. :ref:`ref-tasks-populate_sysroot` task. You
  6563. can use this variable to exclude certain subdirectories of
  6564. directories listed in :term:`SYSROOT_DIRS` from
  6565. staging. By default, the following directories are not staged::
  6566. SYSROOT_DIRS_IGNORE = " \
  6567. ${mandir} \
  6568. ${docdir} \
  6569. ${infodir} \
  6570. ${datadir}/X11/locale \
  6571. ${datadir}/applications \
  6572. ${datadir}/bash-completion \
  6573. ${datadir}/fonts \
  6574. ${datadir}/gtk-doc/html \
  6575. ${datadir}/installed-tests \
  6576. ${datadir}/locale \
  6577. ${datadir}/pixmaps \
  6578. ${datadir}/terminfo \
  6579. ${libdir}/${BPN}/ptest \
  6580. "
  6581. Consider the following example in which you need to manipulate this variable.
  6582. Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is
  6583. installed into a custom folder other than "``${libdir}``"
  6584. or "``${base_libdir}``", let's say "``/opt/lib``".
  6585. .. note::
  6586. This is not a recommended way to deal with shared libraries, but this
  6587. is just to show the usefulness of setting :term:`SYSROOT_DIRS`.
  6588. When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in
  6589. :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B``
  6590. into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``".
  6591. Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to
  6592. ``A``'s :term:`RECIPE_SYSROOT`, which is "``${WORKDIR}/recipe-sysroot``". So,
  6593. the linking process will fail.
  6594. To fix this, you need to add ``/opt/lib`` to :term:`SYSROOT_DIRS`::
  6595. SYSROOT_DIRS:append = " /opt/lib"
  6596. .. note::
  6597. Even after setting ``/opt/lib`` to :term:`SYSROOT_DIRS`, the linking process will still fail
  6598. because the linker does not know that location, since :term:`TARGET_LDFLAGS`
  6599. doesn't contain it (if your recipe is for the target). Therefore, so you should add::
  6600. TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib"
  6601. :term:`SYSROOT_DIRS_NATIVE`
  6602. Extra directories staged into the sysroot by the
  6603. :ref:`ref-tasks-populate_sysroot` task for
  6604. ``-native`` recipes, in addition to those specified in
  6605. :term:`SYSROOT_DIRS`. By default, the following
  6606. extra directories are staged::
  6607. SYSROOT_DIRS_NATIVE = " \
  6608. ${bindir} \
  6609. ${sbindir} \
  6610. ${base_bindir} \
  6611. ${base_sbindir} \
  6612. ${libexecdir} \
  6613. ${sysconfdir} \
  6614. ${localstatedir} \
  6615. "
  6616. .. note::
  6617. Programs built by ``-native`` recipes run directly from the sysroot
  6618. (:term:`STAGING_DIR_NATIVE`), which is why additional directories
  6619. containing program executables and supporting files need to be staged.
  6620. :term:`SYSROOT_PREPROCESS_FUNCS`
  6621. A list of functions to execute after files are staged into the
  6622. sysroot. These functions are usually used to apply additional
  6623. processing on the staged files, or to stage additional files.
  6624. :term:`SYSTEMD_AUTO_ENABLE`
  6625. When inheriting the :ref:`ref-classes-systemd` class,
  6626. this variable specifies whether the specified service in
  6627. :term:`SYSTEMD_SERVICE` should start
  6628. automatically or not. By default, the service is enabled to
  6629. automatically start at boot time. The default setting is in the
  6630. :ref:`ref-classes-systemd` class as follows::
  6631. SYSTEMD_AUTO_ENABLE ??= "enable"
  6632. You can disable the service by setting the variable to "disable".
  6633. :term:`SYSTEMD_BOOT_CFG`
  6634. When :term:`EFI_PROVIDER` is set to
  6635. "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the
  6636. configuration file that should be used. By default, the
  6637. :ref:`ref-classes-systemd-boot` class sets the
  6638. :term:`SYSTEMD_BOOT_CFG` as follows::
  6639. SYSTEMD_BOOT_CFG ?= "${S}/loader.conf"
  6640. For information on Systemd-boot, see the `Systemd-boot
  6641. documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
  6642. :term:`SYSTEMD_BOOT_ENTRIES`
  6643. When :term:`EFI_PROVIDER` is set to
  6644. "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a
  6645. list of entry files (``*.conf``) to install that contain one boot
  6646. entry per file. By default, the :ref:`ref-classes-systemd-boot` class
  6647. sets the :term:`SYSTEMD_BOOT_ENTRIES` as follows::
  6648. SYSTEMD_BOOT_ENTRIES ?= ""
  6649. For information on Systemd-boot, see the `Systemd-boot
  6650. documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
  6651. :term:`SYSTEMD_BOOT_TIMEOUT`
  6652. When :term:`EFI_PROVIDER` is set to
  6653. "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the
  6654. boot menu timeout in seconds. By default, the
  6655. :ref:`ref-classes-systemd-boot` class sets the
  6656. :term:`SYSTEMD_BOOT_TIMEOUT` as follows::
  6657. SYSTEMD_BOOT_TIMEOUT ?= "10"
  6658. For information on Systemd-boot, see the `Systemd-boot
  6659. documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
  6660. :term:`SYSTEMD_DEFAULT_TARGET`
  6661. This variable allows to set the default unit that systemd starts at bootup.
  6662. Usually, this is either ``multi-user.target`` or ``graphical.target``.
  6663. This works by creating a ``default.target`` symbolic link to the chosen systemd
  6664. target file.
  6665. See `systemd's documentation
  6666. <https://www.freedesktop.org/software/systemd/man/systemd.special.html>`__
  6667. for details.
  6668. For example, this variable is used in the :oe_git:`core-image-minimal-xfce.bb
  6669. </meta-openembedded/tree/meta-xfce/recipes-core/images/core-image-minimal-xfce.bb>`
  6670. recipe::
  6671. SYSTEMD_DEFAULT_TARGET = "graphical.target"
  6672. :term:`SYSTEMD_PACKAGES`
  6673. When inheriting the :ref:`ref-classes-systemd` class,
  6674. this variable locates the systemd unit files when they are not found
  6675. in the main recipe's package. By default, the :term:`SYSTEMD_PACKAGES`
  6676. variable is set such that the systemd unit files are assumed to
  6677. reside in the recipes main package::
  6678. SYSTEMD_PACKAGES ?= "${PN}"
  6679. If these unit files are not in this recipe's main package, you need
  6680. to use :term:`SYSTEMD_PACKAGES` to list the package or packages in which
  6681. the build system can find the systemd unit files.
  6682. :term:`SYSTEMD_SERVICE`
  6683. When inheriting the :ref:`ref-classes-systemd` class,
  6684. this variable specifies the systemd service name for a package.
  6685. Multiple services can be specified, each one separated by a space.
  6686. When you specify this file in your recipe, use a package name
  6687. override to indicate the package to which the value applies. Here is
  6688. an example from the connman recipe::
  6689. SYSTEMD_SERVICE:${PN} = "connman.service"
  6690. The package overrides that can be specified are directly related to the value of
  6691. :term:`SYSTEMD_PACKAGES`. Overrides not included in :term:`SYSTEMD_PACKAGES`
  6692. will be silently ignored.
  6693. :term:`SYSVINIT_ENABLED_GETTYS`
  6694. When using :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`,
  6695. specifies a space-separated list of the virtual terminals that should
  6696. run a :wikipedia:`getty <Getty_(Unix)>` (allowing login), assuming
  6697. :term:`USE_VT` is not set to "0".
  6698. The default value for :term:`SYSVINIT_ENABLED_GETTYS` is "1" (i.e. only
  6699. run a getty on the first virtual terminal).
  6700. :term:`T`
  6701. This variable points to a directory were BitBake places temporary
  6702. files, which consist mostly of task logs and scripts, when building a
  6703. particular recipe. The variable is typically set as follows::
  6704. T = "${WORKDIR}/temp"
  6705. The :term:`WORKDIR` is the directory into which
  6706. BitBake unpacks and builds the recipe. The default ``bitbake.conf``
  6707. file sets this variable.
  6708. The :term:`T` variable is not to be confused with the
  6709. :term:`TMPDIR` variable, which points to the root of
  6710. the directory tree where BitBake places the output of an entire
  6711. build.
  6712. :term:`TARGET_ARCH`
  6713. The target machine's architecture. The OpenEmbedded build system
  6714. supports many architectures. Here is an example list of architectures
  6715. supported. This list is by no means complete as the architecture is
  6716. configurable:
  6717. - arm
  6718. - i586
  6719. - x86_64
  6720. - powerpc
  6721. - powerpc64
  6722. - mips
  6723. - mipsel
  6724. For additional information on machine architectures, see the
  6725. :term:`TUNE_ARCH` variable.
  6726. :term:`TARGET_AS_ARCH`
  6727. Specifies architecture-specific assembler flags for the target
  6728. system. :term:`TARGET_AS_ARCH` is initialized from
  6729. :term:`TUNE_ASARGS` by default in the BitBake
  6730. configuration file (``meta/conf/bitbake.conf``)::
  6731. TARGET_AS_ARCH = "${TUNE_ASARGS}"
  6732. :term:`TARGET_CC_ARCH`
  6733. Specifies architecture-specific C compiler flags for the target
  6734. system. :term:`TARGET_CC_ARCH` is initialized from
  6735. :term:`TUNE_CCARGS` by default.
  6736. .. note::
  6737. It is a common workaround to append :term:`LDFLAGS` to
  6738. :term:`TARGET_CC_ARCH` in recipes that build software for the target that
  6739. would not otherwise respect the exported :term:`LDFLAGS` variable.
  6740. :term:`TARGET_CC_KERNEL_ARCH`
  6741. This is a specific kernel compiler flag for a CPU or Application
  6742. Binary Interface (ABI) tune. The flag is used rarely and only for
  6743. cases where a userspace :term:`TUNE_CCARGS` is not
  6744. compatible with the kernel compilation. The :term:`TARGET_CC_KERNEL_ARCH`
  6745. variable allows the kernel (and associated modules) to use a
  6746. different configuration. See the
  6747. ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the
  6748. :term:`Source Directory` for an example.
  6749. :term:`TARGET_CFLAGS`
  6750. Specifies the flags to pass to the C compiler when building for the
  6751. target. When building in the target context,
  6752. :term:`CFLAGS` is set to the value of this variable by
  6753. default.
  6754. Additionally, the SDK's environment setup script sets the :term:`CFLAGS`
  6755. variable in the environment to the :term:`TARGET_CFLAGS` value so that
  6756. executables built using the SDK also have the flags applied.
  6757. :term:`TARGET_CPPFLAGS`
  6758. Specifies the flags to pass to the C pre-processor (i.e. to both the
  6759. C and the C++ compilers) when building for the target. When building
  6760. in the target context, :term:`CPPFLAGS` is set to the
  6761. value of this variable by default.
  6762. Additionally, the SDK's environment setup script sets the
  6763. :term:`CPPFLAGS` variable in the environment to the :term:`TARGET_CPPFLAGS`
  6764. value so that executables built using the SDK also have the flags
  6765. applied.
  6766. :term:`TARGET_CXXFLAGS`
  6767. Specifies the flags to pass to the C++ compiler when building for the
  6768. target. When building in the target context,
  6769. :term:`CXXFLAGS` is set to the value of this variable
  6770. by default.
  6771. Additionally, the SDK's environment setup script sets the
  6772. :term:`CXXFLAGS` variable in the environment to the :term:`TARGET_CXXFLAGS`
  6773. value so that executables built using the SDK also have the flags
  6774. applied.
  6775. :term:`TARGET_FPU`
  6776. Specifies the method for handling FPU code. For FPU-less targets,
  6777. which include most ARM CPUs, the variable must be set to "soft". If
  6778. not, the kernel emulation gets used, which results in a performance
  6779. penalty.
  6780. :term:`TARGET_LD_ARCH`
  6781. Specifies architecture-specific linker flags for the target system.
  6782. :term:`TARGET_LD_ARCH` is initialized from
  6783. :term:`TUNE_LDARGS` by default in the BitBake
  6784. configuration file (``meta/conf/bitbake.conf``)::
  6785. TARGET_LD_ARCH = "${TUNE_LDARGS}"
  6786. :term:`TARGET_LDFLAGS`
  6787. Specifies the flags to pass to the linker when building for the
  6788. target. When building in the target context,
  6789. :term:`LDFLAGS` is set to the value of this variable
  6790. by default.
  6791. Additionally, the SDK's environment setup script sets the
  6792. :term:`LDFLAGS` variable in the environment to the
  6793. :term:`TARGET_LDFLAGS` value so that executables built using the SDK also
  6794. have the flags applied.
  6795. :term:`TARGET_OS`
  6796. Specifies the target's operating system. The variable can be set to
  6797. "linux" for glibc-based systems (GNU C Library) and to "linux-musl"
  6798. for musl libc. For ARM/EABI targets, the possible values are
  6799. "linux-gnueabi" and "linux-musleabi".
  6800. :term:`TARGET_PREFIX`
  6801. Specifies the prefix used for the toolchain binary target tools.
  6802. Depending on the type of recipe and the build target,
  6803. :term:`TARGET_PREFIX` is set as follows:
  6804. - For recipes building for the target machine, the value is
  6805. "${:term:`TARGET_SYS`}-".
  6806. - For native recipes, the build system sets the variable to the
  6807. value of :term:`BUILD_PREFIX`.
  6808. - For native SDK recipes (:ref:`ref-classes-nativesdk`),
  6809. the build system sets the variable to the value of :term:`SDK_PREFIX`.
  6810. :term:`TARGET_SYS`
  6811. Specifies the system, including the architecture and the operating
  6812. system, for which the build is occurring in the context of the
  6813. current recipe.
  6814. The OpenEmbedded build system automatically sets this variable based
  6815. on :term:`TARGET_ARCH`,
  6816. :term:`TARGET_VENDOR`, and
  6817. :term:`TARGET_OS` variables.
  6818. .. note::
  6819. You do not need to set the :term:`TARGET_SYS` variable yourself.
  6820. Consider these two examples:
  6821. - Given a native recipe on a 32-bit, x86 machine running Linux, the
  6822. value is "i686-linux".
  6823. - Given a recipe being built for a little-endian, MIPS target
  6824. running Linux, the value might be "mipsel-linux".
  6825. :term:`TARGET_VENDOR`
  6826. Specifies the name of the target vendor.
  6827. :term:`TCLIBC`
  6828. Specifies the GNU standard C library (``libc``) variant to use during
  6829. the build process.
  6830. You can select "glibc", "musl", "newlib", or "baremetal".
  6831. :term:`TCLIBCAPPEND`
  6832. Specifies a suffix to be appended onto the :term:`TMPDIR` value. The
  6833. suffix identifies the ``libc`` variant for building. When you are
  6834. building for multiple variants with the same :term:`Build Directory`,
  6835. this mechanism ensures that output for different ``libc`` variants is
  6836. kept separate to avoid potential conflicts.
  6837. In the ``defaultsetup.conf`` file, the default value of
  6838. :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky,
  6839. which normally only support one ``libc`` variant, set
  6840. :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting
  6841. in no suffix being applied.
  6842. :term:`TCMODE`
  6843. Specifies the toolchain selector. :term:`TCMODE` controls the
  6844. characteristics of the generated packages and images by telling the
  6845. OpenEmbedded build system which toolchain profile to use. By default,
  6846. the OpenEmbedded build system builds its own internal toolchain. The
  6847. variable's default value is "default", which uses that internal
  6848. toolchain.
  6849. .. note::
  6850. If :term:`TCMODE` is set to a value other than "default", then it is your
  6851. responsibility to ensure that the toolchain is compatible with the
  6852. default toolchain. Using older or newer versions of these
  6853. components might cause build problems. See
  6854. :doc:`Release Information </migration-guides/index>` for your
  6855. version of the Yocto Project, to find the specific components with
  6856. which the toolchain must be compatible.
  6857. The :term:`TCMODE` variable is similar to :term:`TCLIBC`,
  6858. which controls the variant of the GNU standard C library (``libc``)
  6859. used during the build process: ``glibc`` or ``musl``.
  6860. With additional layers, it is possible to use a pre-compiled external
  6861. toolchain. One example is the Sourcery G++ Toolchain. The support for
  6862. this toolchain resides in the separate Mentor Graphics
  6863. ``meta-sourcery`` layer at
  6864. https://github.com/MentorEmbedded/meta-sourcery/.
  6865. The layer's ``README`` file contains information on how to use the
  6866. Sourcery G++ Toolchain as an external toolchain. You will have to
  6867. add the layer to your ``bblayers.conf`` file and then set the
  6868. :term:`EXTERNAL_TOOLCHAIN` variable in your ``local.conf`` file to
  6869. the location of the toolchain.
  6870. The fundamentals used for this example apply to any external
  6871. toolchain. You can use ``meta-sourcery`` as a template for adding
  6872. support for other external toolchains.
  6873. In addition to toolchain configuration, you will also need a
  6874. corresponding toolchain recipe file. This recipe file needs to package
  6875. up any pre-built objects in the toolchain such as ``libgcc``,
  6876. ``libstdcc++``, any locales, and ``libc``.
  6877. :term:`TC_CXX_RUNTIME`
  6878. Specifies the C/C++ STL and runtime variant to use during
  6879. the build process. Default value is 'gnu'
  6880. You can select "gnu", "llvm", or "android".
  6881. :term:`TEMPLATECONF`
  6882. Specifies the directory used by the build system to find templates
  6883. from which to build the ``bblayers.conf`` and ``local.conf`` files.
  6884. Use this variable if you wish to customize such files, and the default
  6885. BitBake targets shown when sourcing the ``oe-init-build-env`` script.
  6886. For details, see the
  6887. :ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`
  6888. section in the Yocto Project Development Tasks manual.
  6889. .. note::
  6890. You must set this variable in the external environment in order
  6891. for it to work.
  6892. :term:`TEST_EXPORT_DIR`
  6893. The location the OpenEmbedded build system uses to export tests when
  6894. the :term:`TEST_EXPORT_ONLY` variable is set
  6895. to "1".
  6896. The :term:`TEST_EXPORT_DIR` variable defaults to
  6897. ``"${TMPDIR}/testimage/${PN}"``.
  6898. :term:`TEST_EXPORT_ONLY`
  6899. Specifies to export the tests only. Set this variable to "1" if you
  6900. do not want to run the tests but you want them to be exported in a
  6901. manner that you to run them outside of the build system.
  6902. :term:`TEST_LOG_DIR`
  6903. Holds the SSH log and the boot log for QEMU machines. The
  6904. :term:`TEST_LOG_DIR` variable defaults to ``"${WORKDIR}/testimage"``.
  6905. .. note::
  6906. Actual test results reside in the task log (``log.do_testimage``),
  6907. which is in the ``${WORKDIR}/temp/`` directory.
  6908. :term:`TEST_POWERCONTROL_CMD`
  6909. For automated hardware testing, specifies the command to use to
  6910. control the power of the target machine under test. Typically, this
  6911. command would point to a script that performs the appropriate action
  6912. (e.g. interacting with a web-enabled power strip). The specified
  6913. command should expect to receive as the last argument "off", "on" or
  6914. "cycle" specifying to power off, on, or cycle (power off and then
  6915. power on) the device, respectively.
  6916. :term:`TEST_POWERCONTROL_EXTRA_ARGS`
  6917. For automated hardware testing, specifies additional arguments to
  6918. pass through to the command specified in
  6919. :term:`TEST_POWERCONTROL_CMD`. Setting
  6920. :term:`TEST_POWERCONTROL_EXTRA_ARGS` is optional. You can use it if you
  6921. wish, for example, to separate the machine-specific and
  6922. non-machine-specific parts of the arguments.
  6923. :term:`TEST_QEMUBOOT_TIMEOUT`
  6924. The time in seconds allowed for an image to boot before automated
  6925. runtime tests begin to run against an image. The default timeout
  6926. period to allow the boot process to reach the login prompt is 500
  6927. seconds. You can specify a different value in the ``local.conf``
  6928. file.
  6929. For more information on testing images, see the
  6930. ":ref:`dev-manual/runtime-testing:performing automated runtime testing`"
  6931. section in the Yocto Project Development Tasks Manual.
  6932. :term:`TEST_SERIALCONTROL_CMD`
  6933. For automated hardware testing, specifies the command to use to
  6934. connect to the serial console of the target machine under test. This
  6935. command simply needs to connect to the serial console and forward
  6936. that connection to standard input and output as any normal terminal
  6937. program does.
  6938. For example, to use the Picocom terminal program on serial device
  6939. ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows::
  6940. TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200"
  6941. :term:`TEST_SERIALCONTROL_EXTRA_ARGS`
  6942. For automated hardware testing, specifies additional arguments to
  6943. pass through to the command specified in
  6944. :term:`TEST_SERIALCONTROL_CMD`. Setting
  6945. :term:`TEST_SERIALCONTROL_EXTRA_ARGS` is optional. You can use it if you
  6946. wish, for example, to separate the machine-specific and
  6947. non-machine-specific parts of the command.
  6948. :term:`TEST_SERVER_IP`
  6949. The IP address of the build machine (host machine). This IP address
  6950. is usually automatically detected. However, if detection fails, this
  6951. variable needs to be set to the IP address of the build machine (i.e.
  6952. where the build is taking place).
  6953. .. note::
  6954. The :term:`TEST_SERVER_IP` variable is only used for a small number of
  6955. tests such as the "dnf" test suite, which needs to download packages
  6956. from ``WORKDIR/oe-rootfs-repo``.
  6957. :term:`TEST_SUITES`
  6958. An ordered list of tests (modules) to run against an image when
  6959. performing automated runtime testing.
  6960. The OpenEmbedded build system provides a core set of tests that can
  6961. be used against images.
  6962. .. note::
  6963. Currently, there is only support for running these tests under
  6964. QEMU.
  6965. Tests include ``ping``, ``ssh``, ``df`` among others. You can add
  6966. your own tests to the list of tests by appending :term:`TEST_SUITES` as
  6967. follows::
  6968. TEST_SUITES:append = " mytest"
  6969. Alternatively, you can
  6970. provide the "auto" option to have all applicable tests run against
  6971. the image::
  6972. TEST_SUITES:append = " auto"
  6973. Using this option causes the
  6974. build system to automatically run tests that are applicable to the
  6975. image. Tests that are not applicable are skipped.
  6976. The order in which tests are run is important. Tests that depend on
  6977. another test must appear later in the list than the test on which
  6978. they depend. For example, if you append the list of tests with two
  6979. tests (``test_A`` and ``test_B``) where ``test_B`` is dependent on
  6980. ``test_A``, then you must order the tests as follows::
  6981. TEST_SUITES = "test_A test_B"
  6982. For more information on testing images, see the
  6983. ":ref:`dev-manual/runtime-testing:performing automated runtime testing`"
  6984. section in the Yocto Project Development Tasks Manual.
  6985. :term:`TEST_TARGET`
  6986. Specifies the target controller to use when running tests against a
  6987. test image. The default controller to use is "qemu"::
  6988. TEST_TARGET = "qemu"
  6989. A target controller is a class that defines how an image gets
  6990. deployed on a target and how a target is started. A layer can extend
  6991. the controllers by adding a module in the layer's
  6992. ``/lib/oeqa/controllers`` directory and by inheriting the
  6993. ``BaseTarget`` class, which is an abstract class that cannot be used
  6994. as a value of :term:`TEST_TARGET`.
  6995. You can provide the following arguments with :term:`TEST_TARGET`:
  6996. - *"qemu":* Boots a QEMU image and runs the tests. See the
  6997. ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section
  6998. in the Yocto Project Development Tasks Manual for more
  6999. information.
  7000. - *"simpleremote":* Runs the tests on target hardware that is
  7001. already up and running. The hardware can be on the network or it
  7002. can be a device running an image on QEMU. You must also set
  7003. :term:`TEST_TARGET_IP` when you use
  7004. "simpleremote".
  7005. .. note::
  7006. This argument is defined in
  7007. ``meta/lib/oeqa/controllers/simpleremote.py``.
  7008. For information on running tests on hardware, see the
  7009. ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`"
  7010. section in the Yocto Project Development Tasks Manual.
  7011. :term:`TEST_TARGET_IP`
  7012. The IP address of your hardware under test. The :term:`TEST_TARGET_IP`
  7013. variable has no effect when :term:`TEST_TARGET` is
  7014. set to "qemu".
  7015. When you specify the IP address, you can also include a port. Here is
  7016. an example::
  7017. TEST_TARGET_IP = "192.168.1.4:2201"
  7018. Specifying a port is
  7019. useful when SSH is started on a non-standard port or in cases when
  7020. your hardware under test is behind a firewall or network that is not
  7021. directly accessible from your host and you need to do port address
  7022. translation.
  7023. :term:`TESTIMAGE_AUTO`
  7024. Automatically runs the series of automated tests for images when an
  7025. image is successfully built. Setting :term:`TESTIMAGE_AUTO` to "1" causes
  7026. any image that successfully builds to automatically boot under QEMU.
  7027. Using the variable also adds in dependencies so that any SDK for
  7028. which testing is requested is automatically built first.
  7029. These tests are written in Python making use of the ``unittest``
  7030. module, and the majority of them run commands on the target system
  7031. over ``ssh``. You can set this variable to "1" in your ``local.conf``
  7032. file in the :term:`Build Directory` to have the
  7033. OpenEmbedded build system automatically run these tests after an
  7034. image successfully builds:
  7035. TESTIMAGE_AUTO = "1"
  7036. For more information
  7037. on enabling, running, and writing these tests, see the
  7038. ":ref:`dev-manual/runtime-testing:performing automated runtime testing`"
  7039. section in the Yocto Project Development Tasks Manual and the
  7040. ":ref:`ref-classes-testimage`" section.
  7041. :term:`THISDIR`
  7042. The directory in which the file BitBake is currently parsing is
  7043. located. Do not manually set this variable.
  7044. :term:`TIME`
  7045. The time the build was started. Times appear using the hour, minute,
  7046. and second (HMS) format (e.g. "140159" for one minute and fifty-nine
  7047. seconds past 1400 hours).
  7048. :term:`TMPDIR`
  7049. This variable is the base directory the OpenEmbedded build system
  7050. uses for all build output and intermediate files (other than the
  7051. shared state cache). By default, the :term:`TMPDIR` variable points to
  7052. ``tmp`` within the :term:`Build Directory`.
  7053. If you want to establish this directory in a location other than the
  7054. default, you can uncomment and edit the following statement in the
  7055. ``conf/local.conf`` file in the :term:`Source Directory`::
  7056. #TMPDIR = "${TOPDIR}/tmp"
  7057. An example use for this scenario is to set :term:`TMPDIR` to a local disk,
  7058. which does not use NFS, while having the :term:`Build Directory` use NFS.
  7059. The filesystem used by :term:`TMPDIR` must have standard filesystem
  7060. semantics (i.e. mixed-case files are unique, POSIX file locking, and
  7061. persistent inodes). Due to various issues with NFS and bugs in some
  7062. implementations, NFS does not meet this minimum requirement.
  7063. Consequently, :term:`TMPDIR` cannot be on NFS.
  7064. :term:`TOOLCHAIN_HOST_TASK`
  7065. This variable lists packages the OpenEmbedded build system uses when
  7066. building an SDK, which contains a cross-development environment. The
  7067. packages specified by this variable are part of the toolchain set
  7068. that runs on the :term:`SDKMACHINE`, and each
  7069. package should usually have the prefix ``nativesdk-``. For example,
  7070. consider the following command when building an SDK::
  7071. $ bitbake -c populate_sdk imagename
  7072. In this case, a default list of packages is
  7073. set in this variable, but you can add additional packages to the
  7074. list. See the
  7075. ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section
  7076. in the Yocto Project Application Development and the Extensible
  7077. Software Development Kit (eSDK) manual for more information.
  7078. For background information on cross-development toolchains in the
  7079. Yocto Project development environment, see the
  7080. ":ref:`sdk-manual/intro:the cross-development toolchain`"
  7081. section in the Yocto Project Overview and Concepts Manual. For
  7082. information on setting up a cross-development environment, see the
  7083. :doc:`/sdk-manual/index` manual.
  7084. Note that this variable applies to building an SDK, not an eSDK,
  7085. in which case the :term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be
  7086. used instead.
  7087. :term:`TOOLCHAIN_HOST_TASK_ESDK`
  7088. This variable allows to extend what is installed in the host
  7089. portion of an eSDK. This is similar to :term:`TOOLCHAIN_HOST_TASK`
  7090. applying to SDKs.
  7091. :term:`TOOLCHAIN_OPTIONS`
  7092. This variable holds extra options passed to the compiler and the linker
  7093. for non ``-native`` recipes as they have to point to their custom
  7094. ``sysroot`` folder pointed to by :term:`RECIPE_SYSROOT`::
  7095. TOOLCHAIN_OPTIONS = " --sysroot=${RECIPE_SYSROOT}"
  7096. Native recipes don't need this variable to be set, as they are
  7097. built for the host machine with the native compiler.
  7098. :term:`TOOLCHAIN_OUTPUTNAME`
  7099. This variable defines the name used for the toolchain output. The
  7100. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets
  7101. the :term:`TOOLCHAIN_OUTPUTNAME` variable as follows::
  7102. TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}"
  7103. See
  7104. the :term:`SDK_NAME` and
  7105. :term:`SDK_VERSION` variables for additional
  7106. information.
  7107. :term:`TOOLCHAIN_TARGET_TASK`
  7108. This variable lists packages the OpenEmbedded build system uses when
  7109. it creates the target part of an SDK (i.e. the part built for the
  7110. target hardware), which includes libraries and headers. Use this
  7111. variable to add individual packages to the part of the SDK that runs
  7112. on the target. See the
  7113. ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section
  7114. in the Yocto Project Application Development and the Extensible
  7115. Software Development Kit (eSDK) manual for more information.
  7116. For background information on cross-development toolchains in the
  7117. Yocto Project development environment, see the
  7118. ":ref:`sdk-manual/intro:the cross-development toolchain`"
  7119. section in the Yocto Project Overview and Concepts Manual. For
  7120. information on setting up a cross-development environment, see the
  7121. :doc:`/sdk-manual/index` manual.
  7122. :term:`TOPDIR`
  7123. See :term:`bitbake:TOPDIR` in the BitBake manual.
  7124. :term:`TRANSLATED_TARGET_ARCH`
  7125. A sanitized version of :term:`TARGET_ARCH`. This
  7126. variable is used where the architecture is needed in a value where
  7127. underscores are not allowed, for example within package filenames. In
  7128. this case, dash characters replace any underscore characters used in
  7129. :term:`TARGET_ARCH`.
  7130. Do not edit this variable.
  7131. :term:`TUNE_ARCH`
  7132. The GNU canonical architecture for a specific architecture (i.e.
  7133. ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses
  7134. this value to setup configuration.
  7135. :term:`TUNE_ARCH` definitions are specific to a given architecture. The
  7136. definitions can be a single static definition, or can be dynamically
  7137. adjusted. You can see details for a given CPU family by looking at
  7138. the architecture's ``README`` file. For example, the
  7139. ``meta/conf/machine/include/mips/README`` file in the
  7140. :term:`Source Directory` provides information for
  7141. :term:`TUNE_ARCH` specific to the ``mips`` architecture.
  7142. :term:`TUNE_ARCH` is tied closely to
  7143. :term:`TARGET_ARCH`, which defines the target
  7144. machine's architecture. The BitBake configuration file
  7145. (``meta/conf/bitbake.conf``) sets :term:`TARGET_ARCH` as follows::
  7146. TARGET_ARCH = "${TUNE_ARCH}"
  7147. The following list, which is by no means complete since architectures
  7148. are configurable, shows supported machine architectures:
  7149. - arm
  7150. - i586
  7151. - x86_64
  7152. - powerpc
  7153. - powerpc64
  7154. - mips
  7155. - mipsel
  7156. :term:`TUNE_ASARGS`
  7157. Specifies architecture-specific assembler flags for the target
  7158. system. The set of flags is based on the selected tune features.
  7159. :term:`TUNE_ASARGS` is set using the tune include files, which are
  7160. typically under ``meta/conf/machine/include/`` and are influenced
  7161. through :term:`TUNE_FEATURES`. For example, the
  7162. ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags
  7163. for the x86 architecture as follows::
  7164. TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}"
  7165. .. note::
  7166. Board Support Packages (BSPs) select the tune. The selected tune,
  7167. in turn, affects the tune variables themselves (i.e. the tune can
  7168. supply its own set of flags).
  7169. :term:`TUNE_CCARGS`
  7170. Specifies architecture-specific C compiler flags for the target
  7171. system. The set of flags is based on the selected tune features.
  7172. :term:`TUNE_CCARGS` is set using the tune include files, which are
  7173. typically under ``meta/conf/machine/include/`` and are influenced
  7174. through :term:`TUNE_FEATURES`.
  7175. .. note::
  7176. Board Support Packages (BSPs) select the tune. The selected tune,
  7177. in turn, affects the tune variables themselves (i.e. the tune can
  7178. supply its own set of flags).
  7179. :term:`TUNE_FEATURES`
  7180. Features used to "tune" a compiler for optimal use given a specific
  7181. processor. The features are defined within the tune files and allow
  7182. arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on
  7183. the features.
  7184. The OpenEmbedded build system verifies the features to be sure they
  7185. are not conflicting and that they are supported.
  7186. The BitBake configuration file (``meta/conf/bitbake.conf``) defines
  7187. :term:`TUNE_FEATURES` as follows::
  7188. TUNE_FEATURES ??= "${TUNE_FEATURES:tune-${DEFAULTTUNE}}"
  7189. See the :term:`DEFAULTTUNE` variable for more information.
  7190. :term:`TUNE_LDARGS`
  7191. Specifies architecture-specific linker flags for the target system.
  7192. The set of flags is based on the selected tune features.
  7193. :term:`TUNE_LDARGS` is set using the tune include files, which are
  7194. typically under ``meta/conf/machine/include/`` and are influenced
  7195. through :term:`TUNE_FEATURES`. For example, the
  7196. ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags
  7197. for the x86 architecture as follows::
  7198. TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}"
  7199. .. note::
  7200. Board Support Packages (BSPs) select the tune. The selected tune,
  7201. in turn, affects the tune variables themselves (i.e. the tune can
  7202. supply its own set of flags).
  7203. :term:`TUNE_PKGARCH`
  7204. The package architecture understood by the packaging system to define
  7205. the architecture, ABI, and tuning of output packages. The specific
  7206. tune is defined using the "_tune" override as follows::
  7207. TUNE_PKGARCH:tune-tune = "tune"
  7208. These tune-specific package architectures are defined in the machine
  7209. include files. Here is an example of the "core2-32" tuning as used in
  7210. the ``meta/conf/machine/include/x86/tune-core2.inc`` file::
  7211. TUNE_PKGARCH:tune-core2-32 = "core2-32"
  7212. :term:`TUNECONFLICTS[feature]`
  7213. Specifies CPU or Application Binary Interface (ABI) tuning features
  7214. that conflict with feature.
  7215. Known tuning conflicts are specified in the machine include files in
  7216. the :term:`Source Directory`. Here is an example from
  7217. the ``meta/conf/machine/include/mips/arch-mips.inc`` include file
  7218. that lists the "o32" and "n64" features as conflicting with the "n32"
  7219. feature::
  7220. TUNECONFLICTS[n32] = "o32 n64"
  7221. :term:`TUNEVALID[feature]`
  7222. Specifies a valid CPU or Application Binary Interface (ABI) tuning
  7223. feature. The specified feature is stored as a flag. Valid features
  7224. are specified in the machine include files (e.g.
  7225. ``meta/conf/machine/include/arm/arch-arm.inc``). Here is an example
  7226. from that file::
  7227. TUNEVALID[bigendian] = "Enable big-endian mode."
  7228. See the machine include files in the :term:`Source Directory`
  7229. for these features.
  7230. :term:`UBOOT_BINARY`
  7231. Specifies the name of the binary build by U-Boot.
  7232. :term:`UBOOT_CONFIG`
  7233. Configures one or more U-Boot configurations to build. Each
  7234. configuration can define the :term:`UBOOT_MACHINE` and optionally the
  7235. :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`.
  7236. Here is an example from the ``meta-freescale`` layer. ::
  7237. UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor"
  7238. UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig"
  7239. UBOOT_CONFIG[sdcard-ifc] = "ls1021atwr_sdcard_ifc_defconfig,,u-boot-with-spl-pbl.bin"
  7240. UBOOT_CONFIG[sdcard-qspi] = "ls1021atwr_sdcard_qspi_defconfig,,u-boot-with-spl-pbl.bin"
  7241. UBOOT_CONFIG[lpuart] = "ls1021atwr_nor_lpuart_defconfig"
  7242. UBOOT_CONFIG[qspi] = "ls1021atwr_qspi_defconfig"
  7243. UBOOT_CONFIG[secure-boot] = "ls1021atwr_nor_SECURE_BOOT_defconfig"
  7244. UBOOT_CONFIG[sdcard-ifc-secure-boot] = "ls1021atwr_sdcard_ifc_SECURE_BOOT_defconfig,,u-boot-with-spl-pbl.bin"
  7245. In this example, all possible seven configurations are selected. Each
  7246. configuration specifies "..._defconfig" as :term:`UBOOT_MACHINE`, and
  7247. the "sd..." configurations define an individual name for
  7248. :term:`UBOOT_BINARY`. No configuration defines a second parameter for
  7249. :term:`IMAGE_FSTYPES` to use for the U-Boot image.
  7250. For more information on how the :term:`UBOOT_CONFIG` is handled, see the
  7251. :ref:`ref-classes-uboot-config` class.
  7252. :term:`UBOOT_DTB_LOADADDRESS`
  7253. Specifies the load address for the dtb image used by U-Boot. During FIT
  7254. image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in
  7255. :ref:`ref-classes-kernel-fitimage` class to specify the load address to be
  7256. used in creating the dtb sections of Image Tree Source for the FIT image.
  7257. :term:`UBOOT_DTBO_LOADADDRESS`
  7258. Specifies the load address for the dtbo image used by U-Boot. During FIT
  7259. image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in
  7260. :ref:`ref-classes-kernel-fitimage` class to specify the load address to be
  7261. used in creating the dtbo sections of Image Tree Source for the FIT image.
  7262. :term:`UBOOT_ENTRYPOINT`
  7263. Specifies the entry point for the U-Boot image. During U-Boot image
  7264. creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a
  7265. command-line parameter to the ``uboot-mkimage`` utility.
  7266. To pass a 64 bit address for FIT image creation, you will need to set:
  7267. - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
  7268. - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
  7269. This variable is used by the :ref:`ref-classes-kernel-fitimage`,
  7270. :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
  7271. :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
  7272. classes.
  7273. :term:`UBOOT_FIT_ADDRESS_CELLS`
  7274. Specifies the value of the ``#address-cells`` value for the
  7275. description of the U-Boot FIT image.
  7276. The default value is set to "1" by the :ref:`ref-classes-uboot-sign`
  7277. class, which corresponds to 32 bit addresses.
  7278. For platforms that need to set 64 bit addresses in
  7279. :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to
  7280. set this value to "2", as two 32 bit values (cells) will be needed
  7281. to represent such addresses.
  7282. Here is an example setting "0x400000000" as a load address::
  7283. UBOOT_FIT_ADDRESS_CELLS = "2"
  7284. UBOOT_LOADADDRESS= "0x04 0x00000000"
  7285. See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__.
  7286. :term:`UBOOT_FIT_DESC`
  7287. Specifies the description string encoded into a U-Boot fitImage. The default
  7288. value is set by the :ref:`ref-classes-uboot-sign` class as follows::
  7289. UBOOT_FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}"
  7290. :term:`UBOOT_FIT_GENERATE_KEYS`
  7291. Decides whether to generate the keys for signing the U-Boot fitImage if
  7292. they don't already exist. The keys are created in :term:`SPL_SIGN_KEYDIR`.
  7293. The default value is "0".
  7294. Enable this as follows::
  7295. UBOOT_FIT_GENERATE_KEYS = "1"
  7296. This variable is used in the :ref:`ref-classes-uboot-sign` class.
  7297. :term:`UBOOT_FIT_HASH_ALG`
  7298. Specifies the hash algorithm used in creating the U-Boot FIT Image.
  7299. It is set by default to ``sha256`` by the :ref:`ref-classes-uboot-sign`
  7300. class.
  7301. :term:`UBOOT_FIT_KEY_GENRSA_ARGS`
  7302. Arguments to ``openssl genrsa`` for generating a RSA private key for
  7303. signing the U-Boot FIT image. The default value of this variable
  7304. is set to "-F4" by the :ref:`ref-classes-uboot-sign` class.
  7305. :term:`UBOOT_FIT_KEY_REQ_ARGS`
  7306. Arguments to ``openssl req`` for generating a certificate for signing
  7307. the U-Boot FIT image. The default value is "-batch -new" by the
  7308. :ref:`ref-classes-uboot-sign` class, "batch" for
  7309. non interactive mode and "new" for generating new keys.
  7310. :term:`UBOOT_FIT_KEY_SIGN_PKCS`
  7311. Format for the public key certificate used for signing the U-Boot FIT
  7312. image. The default value is set to "x509" by the
  7313. :ref:`ref-classes-uboot-sign` class.
  7314. :term:`UBOOT_FIT_SIGN_ALG`
  7315. Specifies the signature algorithm used in creating the U-Boot FIT Image.
  7316. This variable is set by default to "rsa2048" by the
  7317. :ref:`ref-classes-uboot-sign` class.
  7318. :term:`UBOOT_FIT_SIGN_NUMBITS`
  7319. Size of the private key used in signing the U-Boot FIT image, in number
  7320. of bits. The default value for this variable is set to "2048"
  7321. by the :ref:`ref-classes-uboot-sign` class.
  7322. :term:`UBOOT_FITIMAGE_ENABLE`
  7323. This variable allows to generate a FIT image for U-Boot, which is one
  7324. of the ways to implement a verified boot process.
  7325. Its default value is "0", so set it to "1" to enable this functionality::
  7326. UBOOT_FITIMAGE_ENABLE = "1"
  7327. See the :ref:`ref-classes-uboot-sign` class for details.
  7328. :term:`UBOOT_LOADADDRESS`
  7329. Specifies the load address for the U-Boot image. During U-Boot image
  7330. creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a
  7331. command-line parameter to the ``uboot-mkimage`` utility.
  7332. To pass a 64 bit address, you will also need to set:
  7333. - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
  7334. - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
  7335. This variable is used by the :ref:`ref-classes-kernel-fitimage`,
  7336. :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
  7337. :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
  7338. classes.
  7339. :term:`UBOOT_LOCALVERSION`
  7340. Appends a string to the name of the local version of the U-Boot
  7341. image. For example, assuming the version of the U-Boot image built
  7342. was "2013.10", the full version string reported by U-Boot would be
  7343. "2013.10-yocto" given the following statement::
  7344. UBOOT_LOCALVERSION = "-yocto"
  7345. :term:`UBOOT_MACHINE`
  7346. Specifies the value passed on the ``make`` command line when building
  7347. a U-Boot image. The value indicates the target platform
  7348. configuration. You typically set this variable from the machine
  7349. configuration file (i.e. ``conf/machine/machine_name.conf``).
  7350. Please see the "Selection of Processor Architecture and Board Type"
  7351. section in the U-Boot README for valid values for this variable.
  7352. :term:`UBOOT_MAKE_TARGET`
  7353. Specifies the target called in the ``Makefile``. The default target
  7354. is "all".
  7355. :term:`UBOOT_MKIMAGE`
  7356. Specifies the name of the mkimage command as used by the
  7357. :ref:`ref-classes-kernel-fitimage` class to assemble
  7358. the FIT image. This can be used to substitute an alternative command, wrapper
  7359. script or function if desired. The default is "uboot-mkimage".
  7360. :term:`UBOOT_MKIMAGE_DTCOPTS`
  7361. Options for the device tree compiler passed to ``mkimage -D`` feature
  7362. while creating a FIT image with the :ref:`ref-classes-kernel-fitimage`
  7363. class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the
  7364. :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option
  7365. to ``mkimage``.
  7366. This variable is also used by the :ref:`ref-classes-uboot-sign` class.
  7367. :term:`UBOOT_MKIMAGE_KERNEL_TYPE`
  7368. Specifies the type argument for the kernel as passed to ``uboot-mkimage``.
  7369. The default value is "kernel".
  7370. :term:`UBOOT_MKIMAGE_SIGN`
  7371. Specifies the name of the mkimage command as used by the
  7372. :ref:`ref-classes-kernel-fitimage` class to sign
  7373. the FIT image after it has been assembled (if enabled). This can be used
  7374. to substitute an alternative command, wrapper script or function if
  7375. desired. The default is "${:term:`UBOOT_MKIMAGE`}".
  7376. :term:`UBOOT_MKIMAGE_SIGN_ARGS`
  7377. Optionally specifies additional arguments for the
  7378. :ref:`ref-classes-kernel-fitimage` class to pass to the
  7379. mkimage command when signing the FIT image.
  7380. :term:`UBOOT_RD_ENTRYPOINT`
  7381. Specifies the entrypoint for the RAM disk image. During FIT image
  7382. creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in
  7383. :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be
  7384. used in creating the Image Tree Source for the FIT image.
  7385. :term:`UBOOT_RD_LOADADDRESS`
  7386. Specifies the load address for the RAM disk image. During FIT image
  7387. creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in
  7388. :ref:`ref-classes-kernel-fitimage` class to specify the load address to
  7389. be used in creating the Image Tree Source for the FIT image.
  7390. :term:`UBOOT_SIGN_ENABLE`
  7391. Enable signing of FIT image. The default value is "0".
  7392. This variable is used by the :ref:`ref-classes-kernel-fitimage`,
  7393. :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
  7394. classes.
  7395. :term:`UBOOT_SIGN_KEYDIR`
  7396. Location of the directory containing the RSA key and certificate used for
  7397. signing FIT image, used by the :ref:`ref-classes-kernel-fitimage` and
  7398. :ref:`ref-classes-uboot-sign` classes.
  7399. :term:`UBOOT_SIGN_KEYNAME`
  7400. The name of keys used by the :ref:`ref-classes-kernel-fitimage` class
  7401. for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR`
  7402. directory. If we have for example a ``dev.key`` key and a ``dev.crt``
  7403. certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will
  7404. have to set :term:`UBOOT_SIGN_KEYNAME` to ``dev``.
  7405. :term:`UBOOT_SUFFIX`
  7406. Points to the generated U-Boot extension. For example, ``u-boot.sb``
  7407. has a ``.sb`` extension.
  7408. The default U-Boot extension is ``.bin``
  7409. :term:`UBOOT_TARGET`
  7410. Specifies the target used for building U-Boot. The target is passed
  7411. directly as part of the "make" command (e.g. SPL and AIS). If you do
  7412. not specifically set this variable, the OpenEmbedded build process
  7413. passes and uses "all" for the target during the U-Boot building
  7414. process.
  7415. :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`
  7416. Specifies a list of options that, if reported by the configure script
  7417. as being invalid, should not generate a warning during the
  7418. :ref:`ref-tasks-configure` task. Normally, invalid
  7419. configure options are simply not passed to the configure script (e.g.
  7420. should be removed from :term:`EXTRA_OECONF` or
  7421. :term:`PACKAGECONFIG_CONFARGS`).
  7422. However, there are common options that are passed to all
  7423. configure scripts at a class level, but might not be valid for some
  7424. configure scripts. Therefore warnings about these options are useless.
  7425. For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`.
  7426. The configure arguments check that uses
  7427. :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` is part of the
  7428. :ref:`ref-classes-insane` class and is only enabled if the
  7429. recipe inherits the :ref:`ref-classes-autotools` class.
  7430. :term:`UPDATERCPN`
  7431. For recipes inheriting the
  7432. :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN`
  7433. specifies the package that contains the initscript that is enabled.
  7434. The default value is "${PN}". Given that almost all recipes that
  7435. install initscripts package them in the main package for the recipe,
  7436. you rarely need to set this variable in individual recipes.
  7437. :term:`UPSTREAM_CHECK_COMMITS`
  7438. You can perform a per-recipe check for what the latest upstream
  7439. source code version is by calling ``devtool latest-version recipe``. If
  7440. the recipe source code is provided from Git repositories, but
  7441. releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS`
  7442. to ``1`` in the recipe, and the OpenEmbedded build system
  7443. will compare the latest commit with the one currently specified
  7444. by the recipe (:term:`SRCREV`)::
  7445. UPSTREAM_CHECK_COMMITS = "1"
  7446. :term:`UPSTREAM_CHECK_GITTAGREGEX`
  7447. You can perform a per-recipe check for what the latest upstream
  7448. source code version is by calling ``devtool latest-version recipe``. If
  7449. the recipe source code is provided from Git repositories, the
  7450. OpenEmbedded build system determines the latest upstream version by
  7451. picking the latest tag from the list of all repository tags.
  7452. You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a
  7453. regular expression to filter only the relevant tags should the
  7454. default filter not work correctly::
  7455. UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
  7456. :term:`UPSTREAM_CHECK_REGEX`
  7457. Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different
  7458. regular expression instead of the default one when the package
  7459. checking system is parsing the page found using
  7460. :term:`UPSTREAM_CHECK_URI`::
  7461. UPSTREAM_CHECK_REGEX = "package_regex"
  7462. :term:`UPSTREAM_CHECK_URI`
  7463. You can perform a per-recipe check for what the latest upstream
  7464. source code version is by calling ``devtool latest-version recipe``. If
  7465. the source code is provided from tarballs, the latest version is
  7466. determined by fetching the directory listing where the tarball is and
  7467. attempting to find a later tarball. When this approach does not work,
  7468. you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that
  7469. contains the link to the latest tarball::
  7470. UPSTREAM_CHECK_URI = "recipe_url"
  7471. :term:`UPSTREAM_VERSION_UNKNOWN`
  7472. You can perform a per-recipe check for what the latest upstream
  7473. source code version is by calling ``devtool latest-version recipe``.
  7474. If no combination of the :term:`UPSTREAM_CHECK_URI`, :term:`UPSTREAM_CHECK_REGEX`,
  7475. :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in
  7476. the recipe allows to determine what the latest upstream version is,
  7477. you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe
  7478. to acknowledge that the check cannot be performed::
  7479. UPSTREAM_VERSION_UNKNOWN = "1"
  7480. :term:`USE_DEVFS`
  7481. Determines if ``devtmpfs`` is used for ``/dev`` population. The
  7482. default value used for :term:`USE_DEVFS` is "1" when no value is
  7483. specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a
  7484. statically populated ``/dev`` directory.
  7485. See the ":ref:`dev-manual/device-manager:selecting a device manager`" section in
  7486. the Yocto Project Development Tasks Manual for information on how to
  7487. use this variable.
  7488. :term:`USE_VT`
  7489. When using
  7490. :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`,
  7491. determines whether or not to run a :wikipedia:`getty <Getty_(Unix)>`
  7492. on any virtual terminals in order to enable logging in through those
  7493. terminals.
  7494. The default value used for :term:`USE_VT` is "1" when no default value is
  7495. specifically set. Typically, you would set :term:`USE_VT` to "0" in the
  7496. machine configuration file for machines that do not have a graphical
  7497. display attached and therefore do not need virtual terminal
  7498. functionality.
  7499. :term:`USER_CLASSES`
  7500. A list of classes to globally inherit. These classes are used by the
  7501. OpenEmbedded build system to enable extra features.
  7502. Classes inherited using :term:`USER_CLASSES` must be located in the
  7503. ``classes-global/`` or ``classes/`` subdirectories.
  7504. The default list is set in your ``local.conf`` file::
  7505. USER_CLASSES ?= "buildstats"
  7506. For more information, see
  7507. ``meta-poky/conf/templates/default/local.conf.sample`` in the
  7508. :term:`Source Directory`.
  7509. :term:`USERADD_ERROR_DYNAMIC`
  7510. If set to ``error``, forces the OpenEmbedded build system to produce
  7511. an error if the user identification (``uid``) and group
  7512. identification (``gid``) values are not defined in any of the files
  7513. listed in :term:`USERADD_UID_TABLES` and
  7514. :term:`USERADD_GID_TABLES`. If set to
  7515. ``warn``, a warning will be issued instead.
  7516. The default behavior for the build system is to dynamically apply
  7517. ``uid`` and ``gid`` values. Consequently, the
  7518. :term:`USERADD_ERROR_DYNAMIC` variable is by default not set. If you plan
  7519. on using statically assigned ``gid`` and ``uid`` values, you should
  7520. set the :term:`USERADD_ERROR_DYNAMIC` variable in your ``local.conf``
  7521. file as follows::
  7522. USERADD_ERROR_DYNAMIC = "error"
  7523. Overriding the
  7524. default behavior implies you are going to also take steps to set
  7525. static ``uid`` and ``gid`` values through use of the
  7526. :term:`USERADDEXTENSION`,
  7527. :term:`USERADD_UID_TABLES`, and
  7528. :term:`USERADD_GID_TABLES` variables.
  7529. .. note::
  7530. There is a difference in behavior between setting
  7531. :term:`USERADD_ERROR_DYNAMIC` to ``error`` and setting it to ``warn``.
  7532. When it is set to ``warn``, the build system will report a warning for
  7533. every undefined ``uid`` and ``gid`` in any recipe. But when it is set
  7534. to ``error``, it will only report errors for recipes that are actually
  7535. built.
  7536. This saves you from having to add static IDs for recipes that you
  7537. know will never be built.
  7538. :term:`USERADD_GID_TABLES`
  7539. Specifies a password file to use for obtaining static group
  7540. identification (``gid``) values when the OpenEmbedded build system
  7541. adds a group to the system during package installation.
  7542. When applying static group identification (``gid``) values, the
  7543. OpenEmbedded build system looks in :term:`BBPATH` for a
  7544. ``files/group`` file and then applies those ``uid`` values. Set the
  7545. variable as follows in your ``local.conf`` file::
  7546. USERADD_GID_TABLES = "files/group"
  7547. .. note::
  7548. Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
  7549. causes the build system to use static ``gid`` values.
  7550. :term:`USERADD_PACKAGES`
  7551. When inheriting the :ref:`ref-classes-useradd` class,
  7552. this variable specifies the individual packages within the recipe
  7553. that require users and/or groups to be added.
  7554. You must set this variable if the recipe inherits the class. For
  7555. example, the following enables adding a user for the main package in
  7556. a recipe::
  7557. USERADD_PACKAGES = "${PN}"
  7558. .. note::
  7559. It follows that if you are going to use the :term:`USERADD_PACKAGES`
  7560. variable, you need to set one or more of the :term:`USERADD_PARAM`,
  7561. :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables.
  7562. :term:`USERADD_PARAM`
  7563. When inheriting the :ref:`ref-classes-useradd` class,
  7564. this variable specifies for a package what parameters should pass to
  7565. the ``useradd`` command if you add a user to the system when the
  7566. package is installed.
  7567. Here is an example from the ``dbus`` recipe::
  7568. USERADD_PARAM:${PN} = "--system --home ${localstatedir}/lib/dbus \
  7569. --no-create-home --shell /bin/false \
  7570. --user-group messagebus"
  7571. For information on the
  7572. standard Linux shell command ``useradd``, see
  7573. https://linux.die.net/man/8/useradd.
  7574. :term:`USERADD_UID_TABLES`
  7575. Specifies a password file to use for obtaining static user
  7576. identification (``uid``) values when the OpenEmbedded build system
  7577. adds a user to the system during package installation.
  7578. When applying static user identification (``uid``) values, the
  7579. OpenEmbedded build system looks in :term:`BBPATH` for a
  7580. ``files/passwd`` file and then applies those ``uid`` values. Set the
  7581. variable as follows in your ``local.conf`` file::
  7582. USERADD_UID_TABLES = "files/passwd"
  7583. .. note::
  7584. Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
  7585. causes the build system to use static ``uid`` values.
  7586. :term:`USERADDEXTENSION`
  7587. When set to "useradd-staticids", causes the OpenEmbedded build system
  7588. to base all user and group additions on a static ``passwd`` and
  7589. ``group`` files found in :term:`BBPATH`.
  7590. To use static user identification (``uid``) and group identification
  7591. (``gid``) values, set the variable as follows in your ``local.conf``
  7592. file: USERADDEXTENSION = "useradd-staticids"
  7593. .. note::
  7594. Setting this variable to use static ``uid`` and ``gid``
  7595. values causes the OpenEmbedded build system to employ the
  7596. :ref:`ref-classes-useradd` class.
  7597. If you use static ``uid`` and ``gid`` information, you must also
  7598. specify the ``files/passwd`` and ``files/group`` files by setting the
  7599. :term:`USERADD_UID_TABLES` and
  7600. :term:`USERADD_GID_TABLES` variables.
  7601. Additionally, you should also set the
  7602. :term:`USERADD_ERROR_DYNAMIC` variable.
  7603. :term:`VIRTUAL-RUNTIME`
  7604. :term:`VIRTUAL-RUNTIME` is a commonly used prefix for defining virtual
  7605. packages for runtime usage, typically for use in :term:`RDEPENDS`
  7606. or in image definitions.
  7607. An example is ``VIRTUAL-RUNTIME_base-utils`` that makes it possible
  7608. to either use BusyBox based utilities::
  7609. VIRTUAL-RUNTIME_base-utils = "busybox"
  7610. or their full featured implementations from GNU Coreutils
  7611. and other projects::
  7612. VIRTUAL-RUNTIME_base-utils = "packagegroup-core-base-utils"
  7613. Here are two examples using this virtual runtime package. The
  7614. first one is in :yocto_git:`initramfs-framework_1.0.bb
  7615. </poky/tree/meta/recipes-core/initrdscripts/initramfs-framework_1.0.bb?h=scarthgap>`::
  7616. RDEPENDS:${PN} += "${VIRTUAL-RUNTIME_base-utils}"
  7617. The second example is in the :yocto_git:`core-image-initramfs-boot
  7618. </poky/tree/meta/recipes-core/images/core-image-initramfs-boot.bb?h=scarthgap>`
  7619. image definition::
  7620. PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd"
  7621. :term:`VOLATILE_LOG_DIR`
  7622. Specifies the persistence of the target's ``/var/log`` directory,
  7623. which is used to house postinstall target log files.
  7624. By default, :term:`VOLATILE_LOG_DIR` is set to "yes", which means the
  7625. file is not persistent. You can override this setting by setting the
  7626. variable to "no" to make the log directory persistent.
  7627. :term:`VOLATILE_TMP_DIR`
  7628. Specifies the persistence of the target's ``/tmp`` directory.
  7629. By default, :term:`VOLATILE_TMP_DIR` is set to "yes", in which case
  7630. ``/tmp`` links to a directory which resides in RAM in a ``tmpfs``
  7631. filesystem.
  7632. If instead, you want the ``/tmp`` directory to be persistent, set the
  7633. variable to "no" to make it a regular directory in the root filesystem.
  7634. This supports both sysvinit and systemd based systems.
  7635. :term:`WARN_QA`
  7636. Specifies the quality assurance checks whose failures are reported as
  7637. warnings by the OpenEmbedded build system. You set this variable in
  7638. your distribution configuration file. For a list of the checks you
  7639. can control with this variable, see the
  7640. ":ref:`ref-classes-insane`" section.
  7641. :term:`WATCHDOG_TIMEOUT`
  7642. Specifies the timeout in seconds used by the ``watchdog`` recipe and
  7643. also by ``systemd`` during reboot. The default is 60 seconds.
  7644. :term:`WIRELESS_DAEMON`
  7645. For ``connman`` and ``packagegroup-base``, specifies the wireless
  7646. daemon to use. The default is "wpa-supplicant" (note that the value
  7647. uses a dash and not an underscore).
  7648. :term:`WKS_FILE`
  7649. Specifies the location of the Wic kickstart file that is used by the
  7650. OpenEmbedded build system to create a partitioned image
  7651. (``image.wic``). For information on how to create a partitioned
  7652. image, see the
  7653. ":ref:`dev-manual/wic:creating partitioned images using wic`"
  7654. section in the Yocto Project Development Tasks Manual. For details on
  7655. the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter.
  7656. :term:`WKS_FILE_DEPENDS`
  7657. When placed in the recipe that builds your image, this variable lists
  7658. build-time dependencies. The :term:`WKS_FILE_DEPENDS` variable is only
  7659. applicable when Wic images are active (i.e. when
  7660. :term:`IMAGE_FSTYPES` contains entries related
  7661. to Wic). If your recipe does not create Wic images, the variable has
  7662. no effect.
  7663. The :term:`WKS_FILE_DEPENDS` variable is similar to the
  7664. :term:`DEPENDS` variable. When you use the variable in
  7665. your recipe that builds the Wic image, dependencies you list in the
  7666. :term:`WKS_FILE_DEPENDS` variable are added to the :term:`DEPENDS` variable.
  7667. With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to
  7668. specify a list of additional dependencies (e.g. native tools,
  7669. bootloaders, and so forth), that are required to build Wic images.
  7670. Here is an example::
  7671. WKS_FILE_DEPENDS = "some-native-tool"
  7672. In the
  7673. previous example, some-native-tool would be replaced with an actual
  7674. native tool on which the build would depend.
  7675. :term:`WKS_FILES`
  7676. Specifies a list of candidate Wic kickstart files to be used by the
  7677. OpenEmbedded build system to create a partitioned image. Only the
  7678. first one that is found, from left to right, will be used.
  7679. This is only useful when there are multiple ``.wks`` files that can be
  7680. used to produce an image. A typical case is when multiple layers are
  7681. used for different hardware platforms, each supplying a different
  7682. ``.wks`` file. In this case, you specify all possible ones through
  7683. :term:`WKS_FILES`.
  7684. If only one ``.wks`` file is used, set :term:`WKS_FILE` instead.
  7685. :term:`WORKDIR`
  7686. The pathname of the work directory in which the OpenEmbedded build
  7687. system builds a recipe. This directory is located within the
  7688. :term:`TMPDIR` directory structure and is specific to
  7689. the recipe being built and the system for which it is being built.
  7690. The :term:`WORKDIR` directory is defined as follows::
  7691. ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
  7692. The actual directory depends on several things:
  7693. - :term:`TMPDIR`: The top-level build output directory
  7694. - :term:`MULTIMACH_TARGET_SYS`: The target system identifier
  7695. - :term:`PN`: The recipe name
  7696. - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which
  7697. is usually the case for most recipes, then :term:`EXTENDPE` is blank.
  7698. - :term:`PV`: The recipe version
  7699. - :term:`PR`: The recipe revision
  7700. As an example, assume a Source Directory top-level folder name
  7701. ``poky``, a default :term:`Build Directory` at ``poky/build``, and a
  7702. ``qemux86-poky-linux`` machine target system. Furthermore, suppose
  7703. your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work
  7704. directory the build system uses to build the package would be as
  7705. follows::
  7706. poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
  7707. :term:`XSERVER`
  7708. Specifies the packages that should be installed to provide an X
  7709. server and drivers for the current machine, assuming your image
  7710. directly includes ``packagegroup-core-x11-xserver`` or, perhaps
  7711. indirectly, includes "x11-base" in
  7712. :term:`IMAGE_FEATURES`.
  7713. The default value of :term:`XSERVER`, if not specified in the machine
  7714. configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev".
  7715. :term:`XZ_THREADS`
  7716. Specifies the number of parallel threads that should be used when
  7717. using xz compression.
  7718. By default this scales with core count, but is never set less than 2
  7719. to ensure that multi-threaded mode is always used so that the output
  7720. file contents are deterministic. Builds will work with a value of 1
  7721. but the output will differ compared to the output from the compression
  7722. generated when more than one thread is used.
  7723. On systems where many tasks run in parallel, setting a limit to this
  7724. can be helpful in controlling system resource usage.
  7725. :term:`XZ_MEMLIMIT`
  7726. Specifies the maximum memory the xz compression should use as a percentage
  7727. of system memory. If unconstrained the xz compressor can use large amounts of
  7728. memory and become problematic with parallelism elsewhere in the build.
  7729. "50%" has been found to be a good value.
  7730. :term:`ZSTD_THREADS`
  7731. Specifies the number of parallel threads that should be used when
  7732. using ZStandard compression.
  7733. By default this scales with core count, but is never set less than 2
  7734. to ensure that multi-threaded mode is always used so that the output
  7735. file contents are deterministic. Builds will work with a value of 1
  7736. but the output will differ compared to the output from the compression
  7737. generated when more than one thread is used.
  7738. On systems where many tasks run in parallel, setting a limit to this
  7739. can be helpful in controlling system resource usage.