variables.rst 365 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851
  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. :term:`ABIEXTENSION`
  17. Extension to the Application Binary Interface (ABI) field of the GNU
  18. canonical architecture name (e.g. "eabi").
  19. ABI extensions are set in the machine include files. For example, the
  20. ``meta/conf/machine/include/arm/arch-arm.inc`` file sets the
  21. following extension:
  22. ::
  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. ::
  33. ALLOW_EMPTY_${PN} = "1"
  34. ALLOW_EMPTY_${PN}-dev = "1"
  35. ALLOW_EMPTY_${PN}-staticdev = "1"
  36. :term:`ALTERNATIVE`
  37. Lists commands in a package that need an alternative binary naming
  38. scheme. Sometimes the same command is provided in multiple packages.
  39. When this occurs, the OpenEmbedded build system needs to use the
  40. alternatives system to create a different binary naming scheme so the
  41. commands can co-exist.
  42. To use the variable, list out the package's commands that also exist
  43. as part of another package. For example, if the ``busybox`` package
  44. has four commands that also exist as part of another package, you
  45. identify them as follows:
  46. ::
  47. ALTERNATIVE_busybox = "sh sed test bracket"
  48. For more information on the alternatives system, see the
  49. ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
  50. section.
  51. :term:`ALTERNATIVE_LINK_NAME`
  52. Used by the alternatives system to map duplicated commands to actual
  53. locations. For example, if the ``bracket`` command provided by the
  54. ``busybox`` package is duplicated through another package, you must
  55. use the ``ALTERNATIVE_LINK_NAME`` variable to specify the actual
  56. location:
  57. ::
  58. ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/["
  59. In this example, the binary for the ``bracket`` command (i.e. ``[``)
  60. from the ``busybox`` package resides in ``/usr/bin/``.
  61. .. note::
  62. If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``.
  63. For more information on the alternatives system, see the
  64. ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
  65. section.
  66. :term:`ALTERNATIVE_PRIORITY`
  67. Used by the alternatives system to create default priorities for
  68. duplicated commands. You can use the variable to create a single
  69. default regardless of the command name or package, a default for
  70. specific duplicated commands regardless of the package, or a default
  71. for specific commands tied to particular packages. Here are the
  72. available syntax forms:
  73. ::
  74. ALTERNATIVE_PRIORITY = "priority"
  75. ALTERNATIVE_PRIORITY[name] = "priority"
  76. ALTERNATIVE_PRIORITY_pkg[name] = "priority"
  77. For more information on the alternatives system, see the
  78. ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
  79. section.
  80. :term:`ALTERNATIVE_TARGET`
  81. Used by the alternatives system to create default link locations for
  82. duplicated commands. You can use the variable to create a single
  83. default location for all duplicated commands regardless of the
  84. command name or package, a default for specific duplicated commands
  85. regardless of the package, or a default for specific commands tied to
  86. particular packages. Here are the available syntax forms:
  87. ::
  88. ALTERNATIVE_TARGET = "target"
  89. ALTERNATIVE_TARGET[name] = "target"
  90. ALTERNATIVE_TARGET_pkg[name] = "target"
  91. .. note::
  92. If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value
  93. from the :term:`ALTERNATIVE_LINK_NAME` variable.
  94. If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the
  95. same, the target for ``ALTERNATIVE_TARGET`` has "``.{BPN}``"
  96. appended to it.
  97. Finally, if the file referenced has not been renamed, the
  98. alternatives system will rename it to avoid the need to rename
  99. alternative files in the :ref:`ref-tasks-install`
  100. task while retaining support for the command if necessary.
  101. For more information on the alternatives system, see the
  102. ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
  103. section.
  104. :term:`ANY_OF_DISTRO_FEATURES`
  105. When inheriting the
  106. :ref:`features_check <ref-classes-features_check>`
  107. class, this variable identifies a list of distribution features where
  108. at least one must be enabled in the current configuration in order
  109. for the OpenEmbedded build system to build the recipe. In other words,
  110. if none of the features listed in ``ANY_OF_DISTRO_FEATURES``
  111. appear in ``DISTRO_FEATURES`` within the current configuration, then
  112. the recipe will be skipped, and if the build system attempts to build
  113. the recipe then an error will be triggered.
  114. :term:`APPEND`
  115. An override list of append strings for each target specified with
  116. :term:`LABELS`.
  117. See the :ref:`grub-efi <ref-classes-grub-efi>` class for more
  118. information on how this variable is used.
  119. :term:`AR`
  120. The minimal command and arguments used to run ``ar``.
  121. :term:`ARCHIVER_MODE`
  122. When used with the :ref:`archiver <ref-classes-archiver>` class,
  123. determines the type of information used to create a released archive.
  124. You can use this variable to create archives of patched source,
  125. original source, configured source, and so forth by employing the
  126. following variable flags (varflags):
  127. ::
  128. ARCHIVER_MODE[src] = "original" # Uses original (unpacked) source files.
  129. ARCHIVER_MODE[src] = "patched" # Uses patched source files. This is the default.
  130. ARCHIVER_MODE[src] = "configured" # Uses configured source files.
  131. ARCHIVER_MODE[diff] = "1" # Uses patches between do_unpack and do_patch.
  132. ARCHIVER_MODE[diff-exclude] ?= "file file ..." # Lists files and directories to exclude from diff.
  133. ARCHIVER_MODE[dumpdata] = "1" # Uses environment data.
  134. ARCHIVER_MODE[recipe] = "1" # Uses recipe and include files.
  135. ARCHIVER_MODE[srpm] = "1" # Uses RPM package files.
  136. For information on how the variable works, see the
  137. ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`.
  138. :term:`AS`
  139. Minimal command and arguments needed to run the assembler.
  140. :term:`ASSUME_PROVIDED`
  141. Lists recipe names (:term:`PN` values) BitBake does not
  142. attempt to build. Instead, BitBake assumes these recipes have already
  143. been built.
  144. In OpenEmbedded-Core, ``ASSUME_PROVIDED`` mostly specifies native
  145. tools that should not be built. An example is ``git-native``, which
  146. when specified, allows for the Git binary from the host to be used
  147. rather than building ``git-native``.
  148. :term:`ASSUME_SHLIBS`
  149. Provides additional ``shlibs`` provider mapping information, which
  150. adds to or overwrites the information provided automatically by the
  151. system. Separate multiple entries using spaces.
  152. As an example, use the following form to add an ``shlib`` provider of
  153. shlibname in packagename with the optional version:
  154. ::
  155. shlibname:packagename[_version]
  156. Here is an example that adds a shared library named ``libEGL.so.1``
  157. as being provided by the ``libegl-implementation`` package:
  158. ::
  159. ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation"
  160. :term:`AUTHOR`
  161. The email address used to contact the original author or authors in
  162. order to send patches and forward bugs.
  163. :term:`AUTO_LIBNAME_PKGS`
  164. When the :ref:`debian <ref-classes-debian>` class is inherited,
  165. which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which
  166. packages should be checked for libraries and renamed according to
  167. Debian library package naming.
  168. The default value is "${PACKAGES}", which causes the debian class to
  169. act on all packages that are explicitly generated by the recipe.
  170. :term:`AUTO_SYSLINUXMENU`
  171. Enables creating an automatic menu for the syslinux bootloader. You
  172. must set this variable in your recipe. The
  173. :ref:`syslinux <ref-classes-syslinux>` class checks this variable.
  174. :term:`AUTOREV`
  175. When ``SRCREV`` is set to the value of this variable, it specifies to
  176. use the latest source revision in the repository. Here is an example:
  177. ::
  178. SRCREV = "${AUTOREV}"
  179. If you use the previous statement to retrieve the latest version of
  180. software, you need to be sure :term:`PV` contains
  181. ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you
  182. have a kernel recipe that inherits the
  183. :ref:`kernel <ref-classes-kernel>` class and you use the previous
  184. statement. In this example, ``${SRCPV}`` does not automatically get
  185. into ``PV``. Consequently, you need to change ``PV`` in your recipe
  186. so that it does contain ``${SRCPV}``.
  187. For more information see the
  188. ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
  189. section in the Yocto Project Development Tasks Manual.
  190. :term:`AVAILABLE_LICENSES`
  191. List of licenses found in the directories specified by
  192. :term:`COMMON_LICENSE_DIR` and
  193. :term:`LICENSE_PATH`.
  194. .. note::
  195. It is assumed that all changes to ``COMMON_LICENSE_DIR`` and
  196. ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES``
  197. is defined (in :ref:`ref-classes-license`).
  198. :term:`AVAILTUNES`
  199. The list of defined CPU and Application Binary Interface (ABI)
  200. tunings (i.e. "tunes") available for use by the OpenEmbedded build
  201. system.
  202. The list simply presents the tunes that are available. Not all tunes
  203. may be compatible with a particular machine configuration, or with
  204. each other in a
  205. :ref:`Multilib <dev-manual/common-tasks:combining multiple versions of library files into one image>`
  206. configuration.
  207. To add a tune to the list, be sure to append it with spaces using the
  208. "+=" BitBake operator. Do not simply replace the list by using the
  209. "=" operator. See the
  210. ":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake
  211. User Manual for more information.
  212. :term:`B`
  213. The directory within the :term:`Build Directory` in
  214. which the OpenEmbedded build system places generated objects during a
  215. recipe's build process. By default, this directory is the same as the
  216. :term:`S` directory, which is defined as:
  217. ::
  218. S = "${WORKDIR}/${BP}"
  219. You can separate the (``S``) directory and the directory pointed to
  220. by the ``B`` variable. Most Autotools-based recipes support
  221. separating these directories. The build system defaults to using
  222. separate directories for ``gcc`` and some kernel recipes.
  223. :term:`BAD_RECOMMENDATIONS`
  224. Lists "recommended-only" packages to not install. Recommended-only
  225. packages are packages installed only through the
  226. :term:`RRECOMMENDS` variable. You can prevent any
  227. of these "recommended" packages from being installed by listing them
  228. with the ``BAD_RECOMMENDATIONS`` variable:
  229. ::
  230. BAD_RECOMMENDATIONS = "package_name package_name package_name ..."
  231. You can set this variable globally in your ``local.conf`` file or you
  232. can attach it to a specific image recipe by using the recipe name
  233. override:
  234. ::
  235. BAD_RECOMMENDATIONS_pn-target_image = "package_name"
  236. It is important to realize that if you choose to not install packages
  237. using this variable and some other packages are dependent on them
  238. (i.e. listed in a recipe's :term:`RDEPENDS`
  239. variable), the OpenEmbedded build system ignores your request and
  240. will install the packages to avoid dependency errors.
  241. Support for this variable exists only when using the IPK and RPM
  242. packaging backend. Support does not exist for DEB.
  243. See the :term:`NO_RECOMMENDATIONS` and the
  244. :term:`PACKAGE_EXCLUDE` variables for related
  245. information.
  246. :term:`BASE_LIB`
  247. The library directory name for the CPU or Application Binary
  248. Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib
  249. context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`"
  250. section in the Yocto Project Development Tasks Manual for information
  251. on Multilib.
  252. The ``BASE_LIB`` variable is defined in the machine include files in
  253. the :term:`Source Directory`. If Multilib is not
  254. being used, the value defaults to "lib".
  255. :term:`BASE_WORKDIR`
  256. Points to the base of the work directory for all recipes. The default
  257. value is "${TMPDIR}/work".
  258. :term:`BB_ALLOWED_NETWORKS`
  259. Specifies a space-delimited list of hosts that the fetcher is allowed
  260. to use to obtain the required source code. Following are
  261. considerations surrounding this variable:
  262. - This host list is only used if ``BB_NO_NETWORK`` is either not set
  263. or set to "0".
  264. - Limited support for wildcard matching against the beginning of
  265. host names exists. For example, the following setting matches
  266. ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``.
  267. ::
  268. BB_ALLOWED_NETWORKS = "*.gnu.org"
  269. .. note::
  270. The use of the "``*``" character only works at the beginning of
  271. a host name and it must be isolated from the remainder of the
  272. host name. You cannot use the wildcard character in any other
  273. location of the name or combined with the front part of the
  274. name.
  275. For example, ``*.foo.bar`` is supported, while ``*aa.foo.bar``
  276. is not.
  277. - Mirrors not in the host list are skipped and logged in debug.
  278. - Attempts to access networks not in the host list cause a failure.
  279. Using ``BB_ALLOWED_NETWORKS`` in conjunction with
  280. :term:`PREMIRRORS` is very useful. Adding the host
  281. you want to use to ``PREMIRRORS`` results in the source code being
  282. fetched from an allowed location and avoids raising an error when a
  283. host that is not allowed is in a :term:`SRC_URI`
  284. statement. This is because the fetcher does not attempt to use the
  285. host listed in ``SRC_URI`` after a successful fetch from the
  286. ``PREMIRRORS`` occurs.
  287. :term:`BB_DANGLINGAPPENDS_WARNONLY`
  288. Defines how BitBake handles situations where an append file
  289. (``.bbappend``) has no corresponding recipe file (``.bb``). This
  290. condition often occurs when layers get out of sync (e.g. ``oe-core``
  291. bumps a recipe version and the old recipe no longer exists and the
  292. other layer has not been updated to the new version of the recipe
  293. yet).
  294. The default fatal behavior is safest because it is the sane reaction
  295. given something is out of sync. It is important to realize when your
  296. changes are no longer being applied.
  297. You can change the default behavior by setting this variable to "1",
  298. "yes", or "true" in your ``local.conf`` file, which is located in the
  299. :term:`Build Directory`: Here is an example:
  300. ::
  301. BB_DANGLINGAPPENDS_WARNONLY = "1"
  302. :term:`BB_DISKMON_DIRS`
  303. Monitors disk space and available inodes during the build and allows
  304. you to control the build based on these parameters.
  305. Disk space monitoring is disabled by default. To enable monitoring,
  306. add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file
  307. found in the :term:`Build Directory`. Use the
  308. following form:
  309. .. code-block:: none
  310. BB_DISKMON_DIRS = "action,dir,threshold [...]"
  311. where:
  312. action is:
  313. ABORT: Immediately abort the build when
  314. a threshold is broken.
  315. STOPTASKS: Stop the build after the currently
  316. executing tasks have finished when
  317. a threshold is broken.
  318. WARN: Issue a warning but continue the
  319. build when a threshold is broken.
  320. Subsequent warnings are issued as
  321. defined by the BB_DISKMON_WARNINTERVAL
  322. variable, which must be defined in
  323. the conf/local.conf file.
  324. dir is:
  325. Any directory you choose. You can specify one or
  326. more directories to monitor by separating the
  327. groupings with a space. If two directories are
  328. on the same device, only the first directory
  329. is monitored.
  330. threshold is:
  331. Either the minimum available disk space,
  332. the minimum number of free inodes, or
  333. both. You must specify at least one. To
  334. omit one or the other, simply omit the value.
  335. Specify the threshold using G, M, K for Gbytes,
  336. Mbytes, and Kbytes, respectively. If you do
  337. not specify G, M, or K, Kbytes is assumed by
  338. default. Do not use GB, MB, or KB.
  339. Here are some examples:
  340. ::
  341. BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K"
  342. BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G"
  343. BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
  344. The first example works only if you also provide the
  345. :term:`BB_DISKMON_WARNINTERVAL`
  346. variable in the ``conf/local.conf``. This example causes the build
  347. system to immediately abort when either the disk space in
  348. ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops
  349. below 100 Kbytes. Because two directories are provided with the
  350. variable, the build system also issue a warning when the disk space
  351. in the ``${SSTATE_DIR}`` directory drops below 1 Gbyte or the number
  352. of free inodes drops below 100 Kbytes. Subsequent warnings are issued
  353. during intervals as defined by the ``BB_DISKMON_WARNINTERVAL``
  354. variable.
  355. The second example stops the build after all currently executing
  356. tasks complete when the minimum disk space in the ``${TMPDIR}``
  357. directory drops below 1 Gbyte. No disk monitoring occurs for the free
  358. inodes in this case.
  359. The final example immediately aborts the build when the number of
  360. free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No
  361. disk space monitoring for the directory itself occurs in this case.
  362. :term:`BB_DISKMON_WARNINTERVAL`
  363. Defines the disk space and free inode warning intervals. To set these
  364. intervals, define the variable in your ``conf/local.conf`` file in
  365. the :term:`Build Directory`.
  366. If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you
  367. must also use the :term:`BB_DISKMON_DIRS`
  368. variable and define its action as "WARN". During the build,
  369. subsequent warnings are issued each time disk space or number of free
  370. inodes further reduces by the respective interval.
  371. If you do not provide a ``BB_DISKMON_WARNINTERVAL`` variable and you
  372. do use ``BB_DISKMON_DIRS`` with the "WARN" action, the disk
  373. monitoring interval defaults to the following:
  374. ::
  375. BB_DISKMON_WARNINTERVAL = "50M,5K"
  376. When specifying the variable in your configuration file, use the
  377. following form:
  378. .. code-block:: none
  379. BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval"
  380. where:
  381. disk_space_interval is:
  382. An interval of memory expressed in either
  383. G, M, or K for Gbytes, Mbytes, or Kbytes,
  384. respectively. You cannot use GB, MB, or KB.
  385. disk_inode_interval is:
  386. An interval of free inodes expressed in either
  387. G, M, or K for Gbytes, Mbytes, or Kbytes,
  388. respectively. You cannot use GB, MB, or KB.
  389. Here is an example:
  390. ::
  391. BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
  392. BB_DISKMON_WARNINTERVAL = "50M,5K"
  393. These variables cause the
  394. OpenEmbedded build system to issue subsequent warnings each time the
  395. available disk space further reduces by 50 Mbytes or the number of
  396. free inodes further reduces by 5 Kbytes in the ``${SSTATE_DIR}``
  397. directory. Subsequent warnings based on the interval occur each time
  398. a respective interval is reached beyond the initial warning (i.e. 1
  399. Gbytes and 100 Kbytes).
  400. :term:`BB_GENERATE_MIRROR_TARBALLS`
  401. Causes tarballs of the source control repositories (e.g. Git
  402. repositories), including metadata, to be placed in the
  403. :term:`DL_DIR` directory.
  404. For performance reasons, creating and placing tarballs of these
  405. repositories is not the default action by the OpenEmbedded build
  406. system.
  407. ::
  408. BB_GENERATE_MIRROR_TARBALLS = "1"
  409. Set this variable in your
  410. ``local.conf`` file in the :term:`Build Directory`.
  411. Once you have the tarballs containing your source files, you can
  412. clean up your ``DL_DIR`` directory by deleting any Git or other
  413. source control work directories.
  414. :term:`BB_NUMBER_THREADS`
  415. The maximum number of tasks BitBake should run in parallel at any one
  416. time. The OpenEmbedded build system automatically configures this
  417. variable to be equal to the number of cores on the build system. For
  418. example, a system with a dual core processor that also uses
  419. hyper-threading causes the ``BB_NUMBER_THREADS`` variable to default
  420. to "4".
  421. For single socket systems (i.e. one CPU), you should not have to
  422. override this variable to gain optimal parallelism during builds.
  423. However, if you have very large systems that employ multiple physical
  424. CPUs, you might want to make sure the ``BB_NUMBER_THREADS`` variable
  425. is not set higher than "20".
  426. For more information on speeding up builds, see the
  427. ":ref:`dev-manual/common-tasks:speeding up a build`"
  428. section in the Yocto Project Development Tasks Manual.
  429. :term:`BB_SERVER_TIMEOUT`
  430. Specifies the time (in seconds) after which to unload the BitBake
  431. server due to inactivity. Set ``BB_SERVER_TIMEOUT`` to determine how
  432. long the BitBake server stays resident between invocations.
  433. For example, the following statement in your ``local.conf`` file
  434. instructs the server to be unloaded after 20 seconds of inactivity:
  435. ::
  436. BB_SERVER_TIMEOUT = "20"
  437. If you want the server to never be unloaded,
  438. set ``BB_SERVER_TIMEOUT`` to "-1".
  439. :term:`BBCLASSEXTEND`
  440. Allows you to extend a recipe so that it builds variants of the
  441. software. Common variants for recipes exist such as "natives" like
  442. ``quilt-native``, which is a copy of Quilt built to run on the build
  443. system; "crosses" such as ``gcc-cross``, which is a compiler built to
  444. run on the build machine but produces binaries that run on the target
  445. :term:`MACHINE`; "nativesdk", which targets the SDK
  446. machine instead of ``MACHINE``; and "mulitlibs" in the form
  447. "``multilib:``\ multilib_name".
  448. To build a different variant of the recipe with a minimal amount of
  449. code, it usually is as simple as adding the following to your recipe:
  450. ::
  451. BBCLASSEXTEND =+ "native nativesdk"
  452. BBCLASSEXTEND =+ "multilib:multilib_name"
  453. .. note::
  454. Internally, the ``BBCLASSEXTEND`` mechanism generates recipe
  455. variants by rewriting variable values and applying overrides such
  456. as ``_class-native``. For example, to generate a native version of
  457. a recipe, a :term:`DEPENDS` on "foo" is rewritten
  458. to a ``DEPENDS`` on "foo-native".
  459. Even when using ``BBCLASSEXTEND``, the recipe is only parsed once.
  460. Parsing once adds some limitations. For example, it is not
  461. possible to include a different file depending on the variant,
  462. since ``include`` statements are processed when the recipe is
  463. parsed.
  464. :term:`BBFILE_COLLECTIONS`
  465. Lists the names of configured layers. These names are used to find
  466. the other ``BBFILE_*`` variables. Typically, each layer will append
  467. its name to this variable in its ``conf/layer.conf`` file.
  468. :term:`BBFILE_PATTERN`
  469. Variable that expands to match files from
  470. :term:`BBFILES` in a particular layer. This variable
  471. is used in the ``conf/layer.conf`` file and must be suffixed with the
  472. name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``).
  473. :term:`BBFILE_PRIORITY`
  474. Assigns the priority for recipe files in each layer.
  475. This variable is useful in situations where the same recipe appears
  476. in more than one layer. Setting this variable allows you to
  477. prioritize a layer against other layers that contain the same recipe
  478. - effectively letting you control the precedence for the multiple
  479. layers. The precedence established through this variable stands
  480. regardless of a recipe's version (:term:`PV` variable). For
  481. example, a layer that has a recipe with a higher ``PV`` value but for
  482. which the ``BBFILE_PRIORITY`` is set to have a lower precedence still
  483. has a lower precedence.
  484. A larger value for the ``BBFILE_PRIORITY`` variable results in a
  485. higher precedence. For example, the value 6 has a higher precedence
  486. than the value 5. If not specified, the ``BBFILE_PRIORITY`` variable
  487. is set based on layer dependencies (see the ``LAYERDEPENDS`` variable
  488. for more information. The default priority, if unspecified for a
  489. layer with no dependencies, is the lowest defined priority + 1 (or 1
  490. if no priorities are defined).
  491. .. tip::
  492. You can use the command ``bitbake-layers show-layers``
  493. to list all configured layers along with their priorities.
  494. :term:`BBFILES`
  495. A space-separated list of recipe files BitBake uses to build
  496. software.
  497. When specifying recipe files, you can pattern match using Python's
  498. `glob <https://docs.python.org/3/library/glob.html>`_ syntax.
  499. For details on the syntax, see the documentation by following the
  500. previous link.
  501. :term:`BBFILES_DYNAMIC`
  502. Activates content when identified layers are present. You identify
  503. the layers by the collections that the layers define.
  504. Use the ``BBFILES_DYNAMIC`` variable to avoid ``.bbappend`` files
  505. whose corresponding ``.bb`` file is in a layer that attempts to
  506. modify other layers through ``.bbappend`` but does not want to
  507. introduce a hard dependency on those other layers.
  508. Use the following form for ``BBFILES_DYNAMIC``:
  509. collection_name:filename_pattern The following example identifies two
  510. collection names and two filename patterns:
  511. ::
  512. BBFILES_DYNAMIC += " \
  513. clang-layer:${LAYERDIR}/bbappends/meta-clang/*/*/*.bbappend \
  514. core:${LAYERDIR}/bbappends/openembedded-core/meta/*/*/*.bbappend \
  515. "
  516. This next example shows an error message that occurs because invalid
  517. entries are found, which cause parsing to abort:
  518. .. code-block:: none
  519. ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not:
  520. /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend
  521. /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend
  522. :term:`BBINCLUDELOGS`
  523. Variable that controls how BitBake displays logs on build failure.
  524. :term:`BBINCLUDELOGS_LINES`
  525. If :term:`BBINCLUDELOGS` is set, specifies the
  526. maximum number of lines from the task log file to print when
  527. reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``,
  528. the entire log is printed.
  529. :term:`BBLAYERS`
  530. Lists the layers to enable during the build. This variable is defined
  531. in the ``bblayers.conf`` configuration file in the :term:`Build Directory`.
  532. Here is an example:
  533. ::
  534. BBLAYERS = " \
  535. /home/scottrif/poky/meta \
  536. /home/scottrif/poky/meta-poky \
  537. /home/scottrif/poky/meta-yocto-bsp \
  538. /home/scottrif/poky/meta-mykernel \
  539. "
  540. This example enables four layers, one of which is a custom,
  541. user-defined layer named ``meta-mykernel``.
  542. :term:`BBMASK`
  543. Prevents BitBake from processing recipes and recipe append files.
  544. You can use the ``BBMASK`` variable to "hide" these ``.bb`` and
  545. ``.bbappend`` files. BitBake ignores any recipe or recipe append
  546. files that match any of the expressions. It is as if BitBake does not
  547. see them at all. Consequently, matching files are not parsed or
  548. otherwise used by BitBake.
  549. The values you provide are passed to Python's regular expression
  550. compiler. Consequently, the syntax follows Python's Regular
  551. Expression (re) syntax. The expressions are compared against the full
  552. paths to the files. For complete syntax information, see Python's
  553. documentation at https://docs.python.org/3/library/re.html#regular-expression-syntax.
  554. The following example uses a complete regular expression to tell
  555. BitBake to ignore all recipe and recipe append files in the
  556. ``meta-ti/recipes-misc/`` directory:
  557. ::
  558. BBMASK = "meta-ti/recipes-misc/"
  559. If you want to mask out multiple directories or recipes, you can
  560. specify multiple regular expression fragments. This next example
  561. masks out multiple directories and individual recipes: ::
  562. BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/"
  563. BBMASK += "/meta-oe/recipes-support/"
  564. BBMASK += "/meta-foo/.*/openldap"
  565. BBMASK += "opencv.*\.bbappend"
  566. BBMASK += "lzma"
  567. .. note::
  568. When specifying a directory name, use the trailing slash character
  569. to ensure you match just that directory name.
  570. :term:`BBMULTICONFIG`
  571. Specifies each additional separate configuration when you are
  572. building targets with multiple configurations. Use this variable in
  573. your ``conf/local.conf`` configuration file. Specify a
  574. multiconfigname for each configuration file you are using. For
  575. example, the following line specifies three configuration files:
  576. ::
  577. BBMULTICONFIG = "configA configB configC"
  578. Each configuration file you
  579. use must reside in the :term:`Build Directory`
  580. ``conf/multiconfig`` directory (e.g.
  581. build_directory\ ``/conf/multiconfig/configA.conf``).
  582. For information on how to use ``BBMULTICONFIG`` in an environment
  583. that supports building targets with multiple configurations, see the
  584. ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`"
  585. section in the Yocto Project Development Tasks Manual.
  586. :term:`BBPATH`
  587. Used by BitBake to locate ``.bbclass`` and configuration files. This
  588. variable is analogous to the ``PATH`` variable.
  589. .. note::
  590. If you run BitBake from a directory outside of the
  591. Build Directory
  592. , you must be sure to set
  593. BBPATH
  594. to point to the Build Directory. Set the variable as you would any
  595. environment variable and then run BitBake:
  596. ::
  597. $ BBPATH = "build_directory"
  598. $ export BBPATH
  599. $ bitbake target
  600. :term:`BBSERVER`
  601. If defined in the BitBake environment, ``BBSERVER`` points to the
  602. BitBake remote server.
  603. Use the following format to export the variable to the BitBake
  604. environment:
  605. ::
  606. export BBSERVER=localhost:$port
  607. By default, ``BBSERVER`` also appears in
  608. :term:`bitbake:BB_HASHBASE_WHITELIST`.
  609. Consequently, ``BBSERVER`` is excluded from checksum and dependency
  610. data.
  611. :term:`BINCONFIG`
  612. When inheriting the
  613. :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class,
  614. this variable specifies binary configuration scripts to disable in
  615. favor of using ``pkg-config`` to query the information. The
  616. ``binconfig-disabled`` class will modify the specified scripts to
  617. return an error so that calls to them can be easily found and
  618. replaced.
  619. To add multiple scripts, separate them by spaces. Here is an example
  620. from the ``libpng`` recipe:
  621. ::
  622. BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config"
  623. :term:`BINCONFIG_GLOB`
  624. When inheriting the :ref:`binconfig <ref-classes-binconfig>` class,
  625. this variable specifies a wildcard for configuration scripts that
  626. need editing. The scripts are edited to correct any paths that have
  627. been set up during compilation so that they are correct for use when
  628. installed into the sysroot and called by the build processes of other
  629. recipes.
  630. .. note::
  631. The ``BINCONFIG_GLOB`` variable uses
  632. `shell globbing <https://tldp.org/LDP/abs/html/globbingref.html>`__,
  633. which is recognition and expansion of wildcards during pattern
  634. matching. Shell globbing is very similar to
  635. `fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__
  636. and `glob <https://docs.python.org/3/library/glob.html>`__.
  637. For more information on how this variable works, see
  638. ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`.
  639. You can also find general
  640. information on the class in the
  641. ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
  642. :term:`BP`
  643. The base recipe name and version but without any special recipe name
  644. suffix (i.e. ``-native``, ``lib64-``, and so forth). ``BP`` is
  645. comprised of the following:
  646. ::
  647. ${BPN}-${PV}
  648. :term:`BPN`
  649. This variable is a version of the :term:`PN` variable with
  650. common prefixes and suffixes removed, such as ``nativesdk-``,
  651. ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``.
  652. The exact lists of prefixes and suffixes removed are specified by the
  653. :term:`MLPREFIX` and
  654. :term:`SPECIAL_PKGSUFFIX` variables,
  655. respectively.
  656. :term:`BUGTRACKER`
  657. Specifies a URL for an upstream bug tracking website for a recipe.
  658. The OpenEmbedded build system does not use this variable. Rather, the
  659. variable is a useful pointer in case a bug in the software being
  660. built needs to be manually reported.
  661. :term:`BUILD_ARCH`
  662. Specifies the architecture of the build host (e.g. ``i686``). The
  663. OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the
  664. machine name reported by the ``uname`` command.
  665. :term:`BUILD_AS_ARCH`
  666. Specifies the architecture-specific assembler flags for the build
  667. host. By default, the value of ``BUILD_AS_ARCH`` is empty.
  668. :term:`BUILD_CC_ARCH`
  669. Specifies the architecture-specific C compiler flags for the build
  670. host. By default, the value of ``BUILD_CC_ARCH`` is empty.
  671. :term:`BUILD_CCLD`
  672. Specifies the linker command to be used for the build host when the C
  673. compiler is being used as the linker. By default, ``BUILD_CCLD``
  674. points to GCC and passes as arguments the value of
  675. :term:`BUILD_CC_ARCH`, assuming
  676. ``BUILD_CC_ARCH`` is set.
  677. :term:`BUILD_CFLAGS`
  678. Specifies the flags to pass to the C compiler when building for the
  679. build host. When building in the ``-native`` context,
  680. :term:`CFLAGS` is set to the value of this variable by
  681. default.
  682. :term:`BUILD_CPPFLAGS`
  683. Specifies the flags to pass to the C preprocessor (i.e. to both the C
  684. and the C++ compilers) when building for the build host. When
  685. building in the ``-native`` context, :term:`CPPFLAGS`
  686. is set to the value of this variable by default.
  687. :term:`BUILD_CXXFLAGS`
  688. Specifies the flags to pass to the C++ compiler when building for the
  689. build host. When building in the ``-native`` context,
  690. :term:`CXXFLAGS` is set to the value of this variable
  691. by default.
  692. :term:`BUILD_FC`
  693. Specifies the Fortran compiler command for the build host. By
  694. default, ``BUILD_FC`` points to Gfortran and passes as arguments the
  695. value of :term:`BUILD_CC_ARCH`, assuming
  696. ``BUILD_CC_ARCH`` is set.
  697. :term:`BUILD_LD`
  698. Specifies the linker command for the build host. By default,
  699. ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments
  700. the value of :term:`BUILD_LD_ARCH`, assuming
  701. ``BUILD_LD_ARCH`` is set.
  702. :term:`BUILD_LD_ARCH`
  703. Specifies architecture-specific linker flags for the build host. By
  704. default, the value of ``BUILD_LD_ARCH`` is empty.
  705. :term:`BUILD_LDFLAGS`
  706. Specifies the flags to pass to the linker when building for the build
  707. host. When building in the ``-native`` context,
  708. :term:`LDFLAGS` is set to the value of this variable
  709. by default.
  710. :term:`BUILD_OPTIMIZATION`
  711. Specifies the optimization flags passed to the C compiler when
  712. building for the build host or the SDK. The flags are passed through
  713. the :term:`BUILD_CFLAGS` and
  714. :term:`BUILDSDK_CFLAGS` default values.
  715. The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2
  716. -pipe".
  717. :term:`BUILD_OS`
  718. Specifies the operating system in use on the build host (e.g.
  719. "linux"). The OpenEmbedded build system sets the value of
  720. ``BUILD_OS`` from the OS reported by the ``uname`` command - the
  721. first word, converted to lower-case characters.
  722. :term:`BUILD_PREFIX`
  723. The toolchain binary prefix used for native recipes. The OpenEmbedded
  724. build system uses the ``BUILD_PREFIX`` value to set the
  725. :term:`TARGET_PREFIX` when building for
  726. ``native`` recipes.
  727. :term:`BUILD_STRIP`
  728. Specifies the command to be used to strip debugging symbols from
  729. binaries produced for the build host. By default, ``BUILD_STRIP``
  730. points to
  731. ``${``\ :term:`BUILD_PREFIX`\ ``}strip``.
  732. :term:`BUILD_SYS`
  733. Specifies the system, including the architecture and the operating
  734. system, to use when building for the build host (i.e. when building
  735. ``native`` recipes).
  736. The OpenEmbedded build system automatically sets this variable based
  737. on :term:`BUILD_ARCH`,
  738. :term:`BUILD_VENDOR`, and
  739. :term:`BUILD_OS`. You do not need to set the
  740. ``BUILD_SYS`` variable yourself.
  741. :term:`BUILD_VENDOR`
  742. Specifies the vendor name to use when building for the build host.
  743. The default value is an empty string ("").
  744. :term:`BUILDDIR`
  745. Points to the location of the :term:`Build Directory`.
  746. You can define this directory indirectly through the
  747. :ref:`structure-core-script` script by passing in a Build
  748. Directory path when you run the script. If you run the script and do
  749. not provide a Build Directory path, the ``BUILDDIR`` defaults to
  750. ``build`` in the current directory.
  751. :term:`BUILDHISTORY_COMMIT`
  752. When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
  753. class, this variable specifies whether or not to commit the build
  754. history output in a local Git repository. If set to "1", this local
  755. repository will be maintained automatically by the ``buildhistory``
  756. class and a commit will be created on every build for changes to each
  757. top-level subdirectory of the build history output (images, packages,
  758. and sdk). If you want to track changes to build history over time,
  759. you should set this value to "1".
  760. By default, the ``buildhistory`` class does not commit the build
  761. history output in a local Git repository:
  762. ::
  763. BUILDHISTORY_COMMIT ?= "0"
  764. :term:`BUILDHISTORY_COMMIT_AUTHOR`
  765. When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
  766. class, this variable specifies the author to use for each Git commit.
  767. In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the
  768. :term:`BUILDHISTORY_COMMIT` variable must
  769. be set to "1".
  770. Git requires that the value you provide for the
  771. ``BUILDHISTORY_COMMIT_AUTHOR`` variable takes the form of "name
  772. email@host". Providing an email address or host that is not valid
  773. does not produce an error.
  774. By default, the ``buildhistory`` class sets the variable as follows:
  775. ::
  776. BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>"
  777. :term:`BUILDHISTORY_DIR`
  778. When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
  779. class, this variable specifies the directory in which build history
  780. information is kept. For more information on how the variable works,
  781. see the ``buildhistory.class``.
  782. By default, the ``buildhistory`` class sets the directory as follows:
  783. ::
  784. BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
  785. :term:`BUILDHISTORY_FEATURES`
  786. When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
  787. class, this variable specifies the build history features to be
  788. enabled. For more information on how build history works, see the
  789. ":ref:`dev-manual/common-tasks:maintaining build output quality`"
  790. section in the Yocto Project Development Tasks Manual.
  791. You can specify these features in the form of a space-separated list:
  792. - *image:* Analysis of the contents of images, which includes the
  793. list of installed packages among other things.
  794. - *package:* Analysis of the contents of individual packages.
  795. - *sdk:* Analysis of the contents of the software development kit
  796. (SDK).
  797. - *task:* Save output file signatures for
  798. :ref:`shared state <overview-manual/concepts:shared state cache>`
  799. (sstate) tasks.
  800. This saves one file per task and lists the SHA-256 checksums for
  801. each file staged (i.e. the output of the task).
  802. By default, the ``buildhistory`` class enables the following
  803. features:
  804. ::
  805. BUILDHISTORY_FEATURES ?= "image package sdk"
  806. :term:`BUILDHISTORY_IMAGE_FILES`
  807. When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
  808. class, this variable specifies a list of paths to files copied from
  809. the image contents into the build history directory under an
  810. "image-files" directory in the directory for the image, so that you
  811. can track the contents of each file. The default is to copy
  812. ``/etc/passwd`` and ``/etc/group``, which allows you to monitor for
  813. changes in user and group entries. You can modify the list to include
  814. any file. Specifying an invalid path does not produce an error.
  815. Consequently, you can include files that might not always be present.
  816. By default, the ``buildhistory`` class provides paths to the
  817. following files:
  818. ::
  819. BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
  820. :term:`BUILDHISTORY_PUSH_REPO`
  821. When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
  822. class, this variable optionally specifies a remote repository to
  823. which build history pushes Git changes. In order for
  824. ``BUILDHISTORY_PUSH_REPO`` to work,
  825. :term:`BUILDHISTORY_COMMIT` must be set to
  826. "1".
  827. The repository should correspond to a remote address that specifies a
  828. repository as understood by Git, or alternatively to a remote name
  829. that you have set up manually using ``git remote`` within the local
  830. repository.
  831. By default, the ``buildhistory`` class sets the variable as follows:
  832. ::
  833. BUILDHISTORY_PUSH_REPO ?= ""
  834. :term:`BUILDSDK_CFLAGS`
  835. Specifies the flags to pass to the C compiler when building for the
  836. SDK. When building in the ``nativesdk-`` context,
  837. :term:`CFLAGS` is set to the value of this variable by
  838. default.
  839. :term:`BUILDSDK_CPPFLAGS`
  840. Specifies the flags to pass to the C pre-processor (i.e. to both the
  841. C and the C++ compilers) when building for the SDK. When building in
  842. the ``nativesdk-`` context, :term:`CPPFLAGS` is set
  843. to the value of this variable by default.
  844. :term:`BUILDSDK_CXXFLAGS`
  845. Specifies the flags to pass to the C++ compiler when building for the
  846. SDK. When building in the ``nativesdk-`` context,
  847. :term:`CXXFLAGS` is set to the value of this variable
  848. by default.
  849. :term:`BUILDSDK_LDFLAGS`
  850. Specifies the flags to pass to the linker when building for the SDK.
  851. When building in the ``nativesdk-`` context,
  852. :term:`LDFLAGS` is set to the value of this variable
  853. by default.
  854. :term:`BUILDSTATS_BASE`
  855. Points to the location of the directory that holds build statistics
  856. when you use and enable the
  857. :ref:`buildstats <ref-classes-buildstats>` class. The
  858. ``BUILDSTATS_BASE`` directory defaults to
  859. ``${``\ :term:`TMPDIR`\ ``}/buildstats/``.
  860. :term:`BUSYBOX_SPLIT_SUID`
  861. For the BusyBox recipe, specifies whether to split the output
  862. executable file into two parts: one for features that require
  863. ``setuid root``, and one for the remaining features (i.e. those that
  864. do not require ``setuid root``).
  865. The ``BUSYBOX_SPLIT_SUID`` variable defaults to "1", which results in
  866. splitting the output executable file. Set the variable to "0" to get
  867. a single output executable file.
  868. :term:`CACHE`
  869. Specifies the directory BitBake uses to store a cache of the
  870. :term:`Metadata` so it does not need to be parsed every time
  871. BitBake is started.
  872. :term:`CC`
  873. The minimal command and arguments used to run the C compiler.
  874. :term:`CFLAGS`
  875. Specifies the flags to pass to the C compiler. This variable is
  876. exported to an environment variable and thus made visible to the
  877. software being built during the compilation step.
  878. Default initialization for ``CFLAGS`` varies depending on what is
  879. being built:
  880. - :term:`TARGET_CFLAGS` when building for the
  881. target
  882. - :term:`BUILD_CFLAGS` when building for the
  883. build host (i.e. ``-native``)
  884. - :term:`BUILDSDK_CFLAGS` when building for
  885. an SDK (i.e. ``nativesdk-``)
  886. :term:`CLASSOVERRIDE`
  887. An internal variable specifying the special class override that
  888. should currently apply (e.g. "class-target", "class-native", and so
  889. forth). The classes that use this variable (e.g.
  890. :ref:`native <ref-classes-native>`,
  891. :ref:`nativesdk <ref-classes-nativesdk>`, and so forth) set the
  892. variable to appropriate values.
  893. .. note::
  894. ``CLASSOVERRIDE`` gets its default "class-target" value from the
  895. ``bitbake.conf`` file.
  896. As an example, the following override allows you to install extra
  897. files, but only when building for the target:
  898. ::
  899. do_install_append_class-target() {
  900. install my-extra-file ${D}${sysconfdir}
  901. }
  902. Here is an example where ``FOO`` is set to
  903. "native" when building for the build host, and to "other" when not
  904. building for the build host:
  905. ::
  906. FOO_class-native = "native"
  907. FOO = "other"
  908. The underlying mechanism behind ``CLASSOVERRIDE`` is simply
  909. that it is included in the default value of
  910. :term:`OVERRIDES`.
  911. :term:`CLEANBROKEN`
  912. If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the
  913. ``make clean`` command does not work for the software being built.
  914. Consequently, the OpenEmbedded build system will not try to run
  915. ``make clean`` during the :ref:`ref-tasks-configure`
  916. task, which is the default behavior.
  917. :term:`COMBINED_FEATURES`
  918. Provides a list of hardware features that are enabled in both
  919. :term:`MACHINE_FEATURES` and
  920. :term:`DISTRO_FEATURES`. This select list of
  921. features contains features that make sense to be controlled both at
  922. the machine and distribution configuration level. For example, the
  923. "bluetooth" feature requires hardware support but should also be
  924. optional at the distribution level, in case the hardware supports
  925. Bluetooth but you do not ever intend to use it.
  926. :term:`COMMON_LICENSE_DIR`
  927. Points to ``meta/files/common-licenses`` in the
  928. :term:`Source Directory`, which is where generic license
  929. files reside.
  930. :term:`COMPATIBLE_HOST`
  931. A regular expression that resolves to one or more hosts (when the
  932. recipe is native) or one or more targets (when the recipe is
  933. non-native) with which a recipe is compatible. The regular expression
  934. is matched against :term:`HOST_SYS`. You can use the
  935. variable to stop recipes from being built for classes of systems with
  936. which the recipes are not compatible. Stopping these builds is
  937. particularly useful with kernels. The variable also helps to increase
  938. parsing speed since the build system skips parsing recipes not
  939. compatible with the current system.
  940. :term:`COMPATIBLE_MACHINE`
  941. A regular expression that resolves to one or more target machines
  942. with which a recipe is compatible. The regular expression is matched
  943. against :term:`MACHINEOVERRIDES`. You can use
  944. the variable to stop recipes from being built for machines with which
  945. the recipes are not compatible. Stopping these builds is particularly
  946. useful with kernels. The variable also helps to increase parsing
  947. speed since the build system skips parsing recipes not compatible
  948. with the current machine.
  949. :term:`COMPLEMENTARY_GLOB`
  950. Defines wildcards to match when installing a list of complementary
  951. packages for all the packages explicitly (or implicitly) installed in
  952. an image.
  953. .. note::
  954. The ``COMPLEMENTARY_GLOB`` variable uses Unix filename pattern matching
  955. (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__),
  956. which is similar to the Unix style pathname pattern expansion
  957. (`glob <https://docs.python.org/3/library/glob.html>`__).
  958. The resulting list of complementary packages is associated with an
  959. item that can be added to
  960. :term:`IMAGE_FEATURES`. An example usage of
  961. this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES``
  962. will install -dev packages (containing headers and other development
  963. files) for every package in the image.
  964. To add a new feature item pointing to a wildcard, use a variable flag
  965. to specify the feature item name and use the value to specify the
  966. wildcard. Here is an example:
  967. ::
  968. COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
  969. :term:`COMPONENTS_DIR`
  970. Stores sysroot components for each recipe. The OpenEmbedded build
  971. system uses ``COMPONENTS_DIR`` when constructing recipe-specific
  972. sysroots for other recipes.
  973. The default is
  974. "``${``\ :term:`STAGING_DIR`\ ``}-components``."
  975. (i.e.
  976. "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``").
  977. :term:`CONF_VERSION`
  978. Tracks the version of the local configuration file (i.e.
  979. ``local.conf``). The value for ``CONF_VERSION`` increments each time
  980. ``build/conf/`` compatibility changes.
  981. :term:`CONFFILES`
  982. Identifies editable or configurable files that are part of a package.
  983. If the Package Management System (PMS) is being used to update
  984. packages on the target system, it is possible that configuration
  985. files you have changed after the original installation and that you
  986. now want to remain unchanged are overwritten. In other words,
  987. editable files might exist in the package that you do not want reset
  988. as part of the package update process. You can use the ``CONFFILES``
  989. variable to list the files in the package that you wish to prevent
  990. the PMS from overwriting during this update process.
  991. To use the ``CONFFILES`` variable, provide a package name override
  992. that identifies the resulting package. Then, provide a
  993. space-separated list of files. Here is an example:
  994. ::
  995. CONFFILES_${PN} += "${sysconfdir}/file1 \
  996. ${sysconfdir}/file2 ${sysconfdir}/file3"
  997. A relationship exists between the ``CONFFILES`` and ``FILES``
  998. variables. The files listed within ``CONFFILES`` must be a subset of
  999. the files listed within ``FILES``. Because the configuration files
  1000. you provide with ``CONFFILES`` are simply being identified so that
  1001. the PMS will not overwrite them, it makes sense that the files must
  1002. already be included as part of the package through the ``FILES``
  1003. variable.
  1004. .. note::
  1005. When specifying paths as part of the ``CONFFILES`` variable, it is
  1006. good practice to use appropriate path variables.
  1007. For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}``
  1008. rather than ``/usr/bin``. You can find a list of these variables at
  1009. the top of the ``meta/conf/bitbake.conf`` file in the
  1010. :term:`Source Directory`.
  1011. :term:`CONFIG_INITRAMFS_SOURCE`
  1012. Identifies the initial RAM filesystem (initramfs) source files. The
  1013. OpenEmbedded build system receives and uses this kernel Kconfig
  1014. variable as an environment variable. By default, the variable is set
  1015. to null ("").
  1016. The ``CONFIG_INITRAMFS_SOURCE`` can be either a single cpio archive
  1017. with a ``.cpio`` suffix or a space-separated list of directories and
  1018. files for building the initramfs image. A cpio archive should contain
  1019. a filesystem archive to be used as an initramfs image. Directories
  1020. should contain a filesystem layout to be included in the initramfs
  1021. image. Files should contain entries according to the format described
  1022. by the ``usr/gen_init_cpio`` program in the kernel tree.
  1023. If you specify multiple directories and files, the initramfs image
  1024. will be the aggregate of all of them.
  1025. For information on creating an initramfs, see the
  1026. ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
  1027. in the Yocto Project Development Tasks Manual.
  1028. :term:`CONFIG_SITE`
  1029. A list of files that contains ``autoconf`` test results relevant to
  1030. the current build. This variable is used by the Autotools utilities
  1031. when running ``configure``.
  1032. :term:`CONFIGURE_FLAGS`
  1033. The minimal arguments for GNU configure.
  1034. :term:`CONFLICT_DISTRO_FEATURES`
  1035. When inheriting the
  1036. :ref:`features_check <ref-classes-features_check>`
  1037. class, this variable identifies distribution features that would be
  1038. in conflict should the recipe be built. In other words, if the
  1039. ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also
  1040. appears in ``DISTRO_FEATURES`` within the current configuration, then
  1041. the recipe will be skipped, and if the build system attempts to build
  1042. the recipe then an error will be triggered.
  1043. :term:`COPYLEFT_LICENSE_EXCLUDE`
  1044. A space-separated list of licenses to exclude from the source
  1045. archived by the :ref:`archiver <ref-classes-archiver>` class. In
  1046. other words, if a license in a recipe's
  1047. :term:`LICENSE` value is in the value of
  1048. ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the
  1049. class.
  1050. .. note::
  1051. The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the
  1052. :term:`COPYLEFT_LICENSE_INCLUDE` variable.
  1053. The default value, which is "CLOSED Proprietary", for
  1054. ``COPYLEFT_LICENSE_EXCLUDE`` is set by the
  1055. :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
  1056. is inherited by the ``archiver`` class.
  1057. :term:`COPYLEFT_LICENSE_INCLUDE`
  1058. A space-separated list of licenses to include in the source archived
  1059. by the :ref:`archiver <ref-classes-archiver>` class. In other
  1060. words, if a license in a recipe's :term:`LICENSE`
  1061. value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its
  1062. source is archived by the class.
  1063. The default value is set by the
  1064. :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
  1065. is inherited by the ``archiver`` class. The default value includes
  1066. "GPL*", "LGPL*", and "AGPL*".
  1067. :term:`COPYLEFT_PN_EXCLUDE`
  1068. A list of recipes to exclude in the source archived by the
  1069. :ref:`archiver <ref-classes-archiver>` class. The
  1070. ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and
  1071. exclusion caused through the
  1072. :term:`COPYLEFT_LICENSE_INCLUDE` and
  1073. :term:`COPYLEFT_LICENSE_EXCLUDE`
  1074. variables, respectively.
  1075. The default value, which is "" indicating to not explicitly exclude
  1076. any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the
  1077. :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
  1078. is inherited by the ``archiver`` class.
  1079. :term:`COPYLEFT_PN_INCLUDE`
  1080. A list of recipes to include in the source archived by the
  1081. :ref:`archiver <ref-classes-archiver>` class. The
  1082. ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and
  1083. exclusion caused through the
  1084. :term:`COPYLEFT_LICENSE_INCLUDE` and
  1085. :term:`COPYLEFT_LICENSE_EXCLUDE`
  1086. variables, respectively.
  1087. The default value, which is "" indicating to not explicitly include
  1088. any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the
  1089. :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
  1090. is inherited by the ``archiver`` class.
  1091. :term:`COPYLEFT_RECIPE_TYPES`
  1092. A space-separated list of recipe types to include in the source
  1093. archived by the :ref:`archiver <ref-classes-archiver>` class.
  1094. Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``,
  1095. ``crosssdk``, and ``cross-canadian``.
  1096. The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES``
  1097. is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
  1098. class, which is inherited by the ``archiver`` class.
  1099. :term:`COPY_LIC_DIRS`
  1100. If set to "1" along with the
  1101. :term:`COPY_LIC_MANIFEST` variable, the
  1102. OpenEmbedded build system copies into the image the license files,
  1103. which are located in ``/usr/share/common-licenses``, for each
  1104. package. The license files are placed in directories within the image
  1105. itself during build time.
  1106. .. note::
  1107. The ``COPY_LIC_DIRS`` does not offer a path for adding licenses for
  1108. newly installed packages to an image, which might be most suitable for
  1109. read-only filesystems that cannot be upgraded. See the
  1110. :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
  1111. You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
  1112. section in the Yocto Project Development Tasks Manual for
  1113. information on providing license text.
  1114. :term:`COPY_LIC_MANIFEST`
  1115. If set to "1", the OpenEmbedded build system copies the license
  1116. manifest for the image to
  1117. ``/usr/share/common-licenses/license.manifest`` within the image
  1118. itself during build time.
  1119. .. note::
  1120. The ``COPY_LIC_MANIFEST`` does not offer a path for adding licenses for
  1121. newly installed packages to an image, which might be most suitable for
  1122. read-only filesystems that cannot be upgraded. See the
  1123. :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
  1124. You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
  1125. section in the Yocto Project Development Tasks Manual for
  1126. information on providing license text.
  1127. :term:`CORE_IMAGE_EXTRA_INSTALL`
  1128. Specifies the list of packages to be added to the image. You should
  1129. only set this variable in the ``local.conf`` configuration file found
  1130. in the :term:`Build Directory`.
  1131. This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer
  1132. supported.
  1133. :term:`COREBASE`
  1134. Specifies the parent directory of the OpenEmbedded-Core Metadata
  1135. layer (i.e. ``meta``).
  1136. It is an important distinction that ``COREBASE`` points to the parent
  1137. of this layer and not the layer itself. Consider an example where you
  1138. have cloned the Poky Git repository and retained the ``poky`` name
  1139. for your local copy of the repository. In this case, ``COREBASE``
  1140. points to the ``poky`` folder because it is the parent directory of
  1141. the ``poky/meta`` layer.
  1142. :term:`COREBASE_FILES`
  1143. Lists files from the :term:`COREBASE` directory that
  1144. should be copied other than the layers listed in the
  1145. ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for
  1146. the purpose of copying metadata from the OpenEmbedded build system
  1147. into the extensible SDK.
  1148. Explicitly listing files in ``COREBASE`` is needed because it
  1149. typically contains build directories and other files that should not
  1150. normally be copied into the extensible SDK. Consequently, the value
  1151. of ``COREBASE_FILES`` is used in order to only copy the files that
  1152. are actually needed.
  1153. :term:`CPP`
  1154. The minimal command and arguments used to run the C preprocessor.
  1155. :term:`CPPFLAGS`
  1156. Specifies the flags to pass to the C pre-processor (i.e. to both the
  1157. C and the C++ compilers). This variable is exported to an environment
  1158. variable and thus made visible to the software being built during the
  1159. compilation step.
  1160. Default initialization for ``CPPFLAGS`` varies depending on what is
  1161. being built:
  1162. - :term:`TARGET_CPPFLAGS` when building for
  1163. the target
  1164. - :term:`BUILD_CPPFLAGS` when building for the
  1165. build host (i.e. ``-native``)
  1166. - :term:`BUILDSDK_CPPFLAGS` when building
  1167. for an SDK (i.e. ``nativesdk-``)
  1168. :term:`CROSS_COMPILE`
  1169. The toolchain binary prefix for the target tools. The
  1170. ``CROSS_COMPILE`` variable is the same as the
  1171. :term:`TARGET_PREFIX` variable.
  1172. .. note::
  1173. The OpenEmbedded build system sets the ``CROSS_COMPILE``
  1174. variable only in certain contexts (e.g. when building for kernel
  1175. and kernel module recipes).
  1176. :term:`CVSDIR`
  1177. The directory in which files checked out under the CVS system are
  1178. stored.
  1179. :term:`CXX`
  1180. The minimal command and arguments used to run the C++ compiler.
  1181. :term:`CXXFLAGS`
  1182. Specifies the flags to pass to the C++ compiler. This variable is
  1183. exported to an environment variable and thus made visible to the
  1184. software being built during the compilation step.
  1185. Default initialization for ``CXXFLAGS`` varies depending on what is
  1186. being built:
  1187. - :term:`TARGET_CXXFLAGS` when building for
  1188. the target
  1189. - :term:`BUILD_CXXFLAGS` when building for the
  1190. build host (i.e. ``-native``)
  1191. - :term:`BUILDSDK_CXXFLAGS` when building
  1192. for an SDK (i.e. ``nativesdk-``)
  1193. :term:`D`
  1194. The destination directory. The location in the :term:`Build Directory`
  1195. where components are installed by the
  1196. :ref:`ref-tasks-install` task. This location defaults
  1197. to:
  1198. ::
  1199. ${WORKDIR}/image
  1200. .. note::
  1201. Tasks that read from or write to this directory should run under
  1202. :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
  1203. :term:`DATE`
  1204. The date the build was started. Dates appear using the year, month,
  1205. and day (YMD) format (e.g. "20150209" for February 9th, 2015).
  1206. :term:`DATETIME`
  1207. The date and time on which the current build started. The format is
  1208. suitable for timestamps.
  1209. :term:`DEBIAN_NOAUTONAME`
  1210. When the :ref:`debian <ref-classes-debian>` class is inherited,
  1211. which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a
  1212. particular package should not be renamed according to Debian library
  1213. package naming. You must use the package name as an override when you
  1214. set this variable. Here is an example from the ``fontconfig`` recipe:
  1215. ::
  1216. DEBIAN_NOAUTONAME_fontconfig-utils = "1"
  1217. :term:`DEBIANNAME`
  1218. When the :ref:`debian <ref-classes-debian>` class is inherited,
  1219. which is the default behavior, ``DEBIANNAME`` allows you to override
  1220. the library name for an individual package. Overriding the library
  1221. name in these cases is rare. You must use the package name as an
  1222. override when you set this variable. Here is an example from the
  1223. ``dbus`` recipe:
  1224. ::
  1225. DEBIANNAME_${PN} = "dbus-1"
  1226. :term:`DEBUG_BUILD`
  1227. Specifies to build packages with debugging information. This
  1228. influences the value of the ``SELECTED_OPTIMIZATION`` variable.
  1229. :term:`DEBUG_OPTIMIZATION`
  1230. The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when
  1231. compiling a system for debugging. This variable defaults to "-O
  1232. -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
  1233. :term:`DEFAULT_PREFERENCE`
  1234. Specifies a weak bias for recipe selection priority.
  1235. The most common usage of this is variable is to set it to "-1" within
  1236. a recipe for a development version of a piece of software. Using the
  1237. variable in this way causes the stable version of the recipe to build
  1238. by default in the absence of ``PREFERRED_VERSION`` being used to
  1239. build the development version.
  1240. .. note::
  1241. The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden
  1242. by :term:`BBFILE_PRIORITY` if that variable is different between two
  1243. layers that contain different versions of the same recipe.
  1244. :term:`DEFAULTTUNE`
  1245. The default CPU and Application Binary Interface (ABI) tunings (i.e.
  1246. the "tune") used by the OpenEmbedded build system. The
  1247. ``DEFAULTTUNE`` helps define
  1248. :term:`TUNE_FEATURES`.
  1249. The default tune is either implicitly or explicitly set by the
  1250. machine (:term:`MACHINE`). However, you can override
  1251. the setting using available tunes as defined with
  1252. :term:`AVAILTUNES`.
  1253. :term:`DEPENDS`
  1254. Lists a recipe's build-time dependencies. These are dependencies on
  1255. other recipes whose contents (e.g. headers and shared libraries) are
  1256. needed by the recipe at build time.
  1257. As an example, consider a recipe ``foo`` that contains the following
  1258. assignment:
  1259. ::
  1260. DEPENDS = "bar"
  1261. The practical effect of the previous
  1262. assignment is that all files installed by bar will be available in
  1263. the appropriate staging sysroot, given by the
  1264. :term:`STAGING_DIR* <STAGING_DIR>` variables, by the time the
  1265. :ref:`ref-tasks-configure` task for ``foo`` runs.
  1266. This mechanism is implemented by having ``do_configure`` depend on
  1267. the :ref:`ref-tasks-populate_sysroot` task of
  1268. each recipe listed in ``DEPENDS``, through a
  1269. ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
  1270. declaration in the :ref:`base <ref-classes-base>` class.
  1271. .. note::
  1272. It seldom is necessary to reference, for example, ``STAGING_DIR_HOST``
  1273. explicitly. The standard classes and build-related variables are
  1274. configured to automatically use the appropriate staging sysroots.
  1275. As another example, ``DEPENDS`` can also be used to add utilities
  1276. that run on the build machine during the build. For example, a recipe
  1277. that makes use of a code generator built by the recipe ``codegen``
  1278. might have the following:
  1279. ::
  1280. DEPENDS = "codegen-native"
  1281. For more
  1282. information, see the :ref:`native <ref-classes-native>` class and
  1283. the :term:`EXTRANATIVEPATH` variable.
  1284. .. note::
  1285. - ``DEPENDS`` is a list of recipe names. Or, to be more precise,
  1286. it is a list of :term:`PROVIDES` names, which
  1287. usually match recipe names. Putting a package name such as
  1288. "foo-dev" in ``DEPENDS`` does not make sense. Use "foo"
  1289. instead, as this will put files from all the packages that make
  1290. up ``foo``, which includes those from ``foo-dev``, into the
  1291. sysroot.
  1292. - One recipe having another recipe in ``DEPENDS`` does not by
  1293. itself add any runtime dependencies between the packages
  1294. produced by the two recipes. However, as explained in the
  1295. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  1296. section in the Yocto Project Overview and Concepts Manual,
  1297. runtime dependencies will often be added automatically, meaning
  1298. ``DEPENDS`` alone is sufficient for most recipes.
  1299. - Counterintuitively, ``DEPENDS`` is often necessary even for
  1300. recipes that install precompiled components. For example, if
  1301. ``libfoo`` is a precompiled library that links against
  1302. ``libbar``, then linking against ``libfoo`` requires both
  1303. ``libfoo`` and ``libbar`` to be available in the sysroot.
  1304. Without a ``DEPENDS`` from the recipe that installs ``libfoo``
  1305. to the recipe that installs ``libbar``, other recipes might
  1306. fail to link against ``libfoo``.
  1307. For information on runtime dependencies, see the
  1308. :term:`RDEPENDS` variable. You can also see the
  1309. ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
  1310. ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
  1311. BitBake User Manual for additional information on tasks and
  1312. dependencies.
  1313. :term:`DEPLOY_DIR`
  1314. Points to the general area that the OpenEmbedded build system uses to
  1315. place images, packages, SDKs, and other output files that are ready
  1316. to be used outside of the build system. By default, this directory
  1317. resides within the :term:`Build Directory` as
  1318. ``${TMPDIR}/deploy``.
  1319. For more information on the structure of the Build Directory, see
  1320. ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section.
  1321. For more detail on the contents of the ``deploy`` directory, see the
  1322. ":ref:`overview-manual/concepts:images`",
  1323. ":ref:`overview-manual/concepts:package feeds`", and
  1324. ":ref:`overview-manual/concepts:application development sdk`" sections all in the
  1325. Yocto Project Overview and Concepts Manual.
  1326. :term:`DEPLOY_DIR_DEB`
  1327. Points to the area that the OpenEmbedded build system uses to place
  1328. Debian packages that are ready to be used outside of the build
  1329. system. This variable applies only when
  1330. :term:`PACKAGE_CLASSES` contains
  1331. "package_deb".
  1332. The BitBake configuration file initially defines the
  1333. ``DEPLOY_DIR_DEB`` variable as a sub-folder of
  1334. :term:`DEPLOY_DIR`:
  1335. ::
  1336. DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
  1337. The :ref:`package_deb <ref-classes-package_deb>` class uses the
  1338. ``DEPLOY_DIR_DEB`` variable to make sure the
  1339. :ref:`ref-tasks-package_write_deb` task
  1340. writes Debian packages into the appropriate folder. For more
  1341. information on how packaging works, see the
  1342. ":ref:`overview-manual/concepts:package feeds`" section
  1343. in the Yocto Project Overview and Concepts Manual.
  1344. :term:`DEPLOY_DIR_IMAGE`
  1345. Points to the area that the OpenEmbedded build system uses to place
  1346. images and other associated output files that are ready to be
  1347. deployed onto the target machine. The directory is machine-specific
  1348. as it contains the ``${MACHINE}`` name. By default, this directory
  1349. resides within the :term:`Build Directory` as
  1350. ``${DEPLOY_DIR}/images/${MACHINE}/``.
  1351. For more information on the structure of the Build Directory, see
  1352. ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section.
  1353. For more detail on the contents of the ``deploy`` directory, see the
  1354. ":ref:`overview-manual/concepts:images`" and
  1355. ":ref:`overview-manual/concepts:application development sdk`" sections both in
  1356. the Yocto Project Overview and Concepts Manual.
  1357. :term:`DEPLOY_DIR_IPK`
  1358. Points to the area that the OpenEmbedded build system uses to place
  1359. IPK packages that are ready to be used outside of the build system.
  1360. This variable applies only when
  1361. :term:`PACKAGE_CLASSES` contains
  1362. "package_ipk".
  1363. The BitBake configuration file initially defines this variable as a
  1364. sub-folder of :term:`DEPLOY_DIR`:
  1365. ::
  1366. DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk"
  1367. The :ref:`package_ipk <ref-classes-package_ipk>` class uses the
  1368. ``DEPLOY_DIR_IPK`` variable to make sure the
  1369. :ref:`ref-tasks-package_write_ipk` task
  1370. writes IPK packages into the appropriate folder. For more information
  1371. on how packaging works, see the
  1372. ":ref:`overview-manual/concepts:package feeds`" section
  1373. in the Yocto Project Overview and Concepts Manual.
  1374. :term:`DEPLOY_DIR_RPM`
  1375. Points to the area that the OpenEmbedded build system uses to place
  1376. RPM packages that are ready to be used outside of the build system.
  1377. This variable applies only when
  1378. :term:`PACKAGE_CLASSES` contains
  1379. "package_rpm".
  1380. The BitBake configuration file initially defines this variable as a
  1381. sub-folder of :term:`DEPLOY_DIR`:
  1382. ::
  1383. DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm"
  1384. The :ref:`package_rpm <ref-classes-package_rpm>` class uses the
  1385. ``DEPLOY_DIR_RPM`` variable to make sure the
  1386. :ref:`ref-tasks-package_write_rpm` task
  1387. writes RPM packages into the appropriate folder. For more information
  1388. on how packaging works, see the
  1389. ":ref:`overview-manual/concepts:package feeds`" section
  1390. in the Yocto Project Overview and Concepts Manual.
  1391. :term:`DEPLOY_DIR_TAR`
  1392. Points to the area that the OpenEmbedded build system uses to place
  1393. tarballs that are ready to be used outside of the build system. This
  1394. variable applies only when
  1395. :term:`PACKAGE_CLASSES` contains
  1396. "package_tar".
  1397. The BitBake configuration file initially defines this variable as a
  1398. sub-folder of :term:`DEPLOY_DIR`:
  1399. ::
  1400. DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar"
  1401. The :ref:`package_tar <ref-classes-package_tar>` class uses the
  1402. ``DEPLOY_DIR_TAR`` variable to make sure the
  1403. :ref:`ref-tasks-package_write_tar` task
  1404. writes TAR packages into the appropriate folder. For more information
  1405. on how packaging works, see the
  1406. ":ref:`overview-manual/concepts:package feeds`" section
  1407. in the Yocto Project Overview and Concepts Manual.
  1408. :term:`DEPLOYDIR`
  1409. When inheriting the :ref:`deploy <ref-classes-deploy>` class, the
  1410. ``DEPLOYDIR`` points to a temporary work area for deployed files that
  1411. is set in the ``deploy`` class as follows:
  1412. ::
  1413. DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
  1414. Recipes inheriting the ``deploy`` class should copy files to be
  1415. deployed into ``DEPLOYDIR``, and the class will take care of copying
  1416. them into :term:`DEPLOY_DIR_IMAGE`
  1417. afterwards.
  1418. :term:`DESCRIPTION`
  1419. The package description used by package managers. If not set,
  1420. ``DESCRIPTION`` takes the value of the :term:`SUMMARY`
  1421. variable.
  1422. :term:`DISTRO`
  1423. The short name of the distribution. For information on the long name
  1424. of the distribution, see the :term:`DISTRO_NAME`
  1425. variable.
  1426. The ``DISTRO`` variable corresponds to a distribution configuration
  1427. file whose root name is the same as the variable's argument and whose
  1428. filename extension is ``.conf``. For example, the distribution
  1429. configuration file for the Poky distribution is named ``poky.conf``
  1430. and resides in the ``meta-poky/conf/distro`` directory of the
  1431. :term:`Source Directory`.
  1432. Within that ``poky.conf`` file, the ``DISTRO`` variable is set as
  1433. follows:
  1434. ::
  1435. DISTRO = "poky"
  1436. Distribution configuration files are located in a ``conf/distro``
  1437. directory within the :term:`Metadata` that contains the
  1438. distribution configuration. The value for ``DISTRO`` must not contain
  1439. spaces, and is typically all lower-case.
  1440. .. note::
  1441. If the ``DISTRO`` variable is blank, a set of default configurations
  1442. are used, which are specified within
  1443. ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
  1444. :term:`DISTRO_CODENAME`
  1445. Specifies a codename for the distribution being built.
  1446. :term:`DISTRO_EXTRA_RDEPENDS`
  1447. Specifies a list of distro-specific packages to add to all images.
  1448. This variable takes affect through ``packagegroup-base`` so the
  1449. variable only really applies to the more full-featured images that
  1450. include ``packagegroup-base``. You can use this variable to keep
  1451. distro policy out of generic images. As with all other distro
  1452. variables, you set this variable in the distro ``.conf`` file.
  1453. :term:`DISTRO_EXTRA_RRECOMMENDS`
  1454. Specifies a list of distro-specific packages to add to all images if
  1455. the packages exist. The packages might not exist or be empty (e.g.
  1456. kernel modules). The list of packages are automatically installed but
  1457. you can remove them.
  1458. :term:`DISTRO_FEATURES`
  1459. The software support you want in your distribution for various
  1460. features. You define your distribution features in the distribution
  1461. configuration file.
  1462. In most cases, the presence or absence of a feature in
  1463. ``DISTRO_FEATURES`` is translated to the appropriate option supplied
  1464. to the configure script during the
  1465. :ref:`ref-tasks-configure` task for recipes that
  1466. optionally support the feature. For example, specifying "x11" in
  1467. ``DISTRO_FEATURES``, causes every piece of software built for the
  1468. target that can optionally support X11 to have its X11 support
  1469. enabled.
  1470. Two more examples are Bluetooth and NFS support. For a more complete
  1471. list of features that ships with the Yocto Project and that you can
  1472. provide with this variable, see the ":ref:`ref-features-distro`" section.
  1473. :term:`DISTRO_FEATURES_BACKFILL`
  1474. Features to be added to ``DISTRO_FEATURES`` if not also present in
  1475. ``DISTRO_FEATURES_BACKFILL_CONSIDERED``.
  1476. This variable is set in the ``meta/conf/bitbake.conf`` file. It is
  1477. not intended to be user-configurable. It is best to just reference
  1478. the variable to see which distro features are being backfilled for
  1479. all distro configurations. See the ":ref:`ref-features-backfill`" section
  1480. for more information.
  1481. :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
  1482. Features from ``DISTRO_FEATURES_BACKFILL`` that should not be
  1483. backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See
  1484. the ":ref:`ref-features-backfill`" section for more information.
  1485. :term:`DISTRO_FEATURES_DEFAULT`
  1486. A convenience variable that gives you the default list of distro
  1487. features with the exception of any features specific to the C library
  1488. (``libc``).
  1489. When creating a custom distribution, you might find it useful to be
  1490. able to reuse the default
  1491. :term:`DISTRO_FEATURES` options without the
  1492. need to write out the full set. Here is an example that uses
  1493. ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file:
  1494. ::
  1495. DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature"
  1496. :term:`DISTRO_FEATURES_FILTER_NATIVE`
  1497. Specifies a list of features that if present in the target
  1498. :term:`DISTRO_FEATURES` value should be
  1499. included in ``DISTRO_FEATURES`` when building native recipes. This
  1500. variable is used in addition to the features filtered using the
  1501. :term:`DISTRO_FEATURES_NATIVE`
  1502. variable.
  1503. :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
  1504. Specifies a list of features that if present in the target
  1505. :term:`DISTRO_FEATURES` value should be
  1506. included in ``DISTRO_FEATURES`` when building nativesdk recipes. This
  1507. variable is used in addition to the features filtered using the
  1508. :term:`DISTRO_FEATURES_NATIVESDK`
  1509. variable.
  1510. :term:`DISTRO_FEATURES_NATIVE`
  1511. Specifies a list of features that should be included in
  1512. :term:`DISTRO_FEATURES` when building native
  1513. recipes. This variable is used in addition to the features filtered
  1514. using the
  1515. :term:`DISTRO_FEATURES_FILTER_NATIVE`
  1516. variable.
  1517. :term:`DISTRO_FEATURES_NATIVESDK`
  1518. Specifies a list of features that should be included in
  1519. :term:`DISTRO_FEATURES` when building
  1520. nativesdk recipes. This variable is used in addition to the features
  1521. filtered using the
  1522. :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
  1523. variable.
  1524. :term:`DISTRO_NAME`
  1525. The long name of the distribution. For information on the short name
  1526. of the distribution, see the :term:`DISTRO` variable.
  1527. The ``DISTRO_NAME`` variable corresponds to a distribution
  1528. configuration file whose root name is the same as the variable's
  1529. argument and whose filename extension is ``.conf``. For example, the
  1530. distribution configuration file for the Poky distribution is named
  1531. ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory
  1532. of the :term:`Source Directory`.
  1533. Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set
  1534. as follows:
  1535. ::
  1536. DISTRO_NAME = "Poky (Yocto Project Reference Distro)"
  1537. Distribution configuration files are located in a ``conf/distro``
  1538. directory within the :term:`Metadata` that contains the
  1539. distribution configuration.
  1540. .. note::
  1541. If the ``DISTRO_NAME`` variable is blank, a set of default
  1542. configurations are used, which are specified within
  1543. ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
  1544. :term:`DISTRO_VERSION`
  1545. The version of the distribution.
  1546. :term:`DISTROOVERRIDES`
  1547. A colon-separated list of overrides specific to the current
  1548. distribution. By default, this list includes the value of
  1549. :term:`DISTRO`.
  1550. You can extend ``DISTROOVERRIDES`` to add extra overrides that should
  1551. apply to the distribution.
  1552. The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it
  1553. is included in the default value of
  1554. :term:`OVERRIDES`.
  1555. :term:`DL_DIR`
  1556. The central download directory used by the build process to store
  1557. downloads. By default, ``DL_DIR`` gets files suitable for mirroring
  1558. for everything except Git repositories. If you want tarballs of Git
  1559. repositories, use the
  1560. :term:`BB_GENERATE_MIRROR_TARBALLS`
  1561. variable.
  1562. You can set this directory by defining the ``DL_DIR`` variable in the
  1563. ``conf/local.conf`` file. This directory is self-maintaining and you
  1564. should not have to touch it. By default, the directory is
  1565. ``downloads`` in the :term:`Build Directory`.
  1566. ::
  1567. #DL_DIR ?= "${TOPDIR}/downloads"
  1568. To specify a different download directory,
  1569. simply remove the comment from the line and provide your directory.
  1570. During a first build, the system downloads many different source code
  1571. tarballs from various upstream projects. Downloading can take a
  1572. while, particularly if your network connection is slow. Tarballs are
  1573. all stored in the directory defined by ``DL_DIR`` and the build
  1574. system looks there first to find source tarballs.
  1575. .. note::
  1576. When wiping and rebuilding, you can preserve this directory to
  1577. speed up this part of subsequent builds.
  1578. You can safely share this directory between multiple builds on the
  1579. same development machine. For additional information on how the build
  1580. process gets source files when working behind a firewall or proxy
  1581. server, see this specific question in the ":doc:`faq`"
  1582. chapter. You can also refer to the
  1583. ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
  1584. Wiki page.
  1585. :term:`DOC_COMPRESS`
  1586. When inheriting the :ref:`compress_doc <ref-classes-compress_doc>`
  1587. class, this variable sets the compression policy used when the
  1588. OpenEmbedded build system compresses man pages and info pages. By
  1589. default, the compression method used is gz (gzip). Other policies
  1590. available are xz and bz2.
  1591. For information on policies and on how to use this variable, see the
  1592. comments in the ``meta/classes/compress_doc.bbclass`` file.
  1593. :term:`EFI_PROVIDER`
  1594. When building bootable images (i.e. where ``hddimg``, ``iso``, or
  1595. ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the
  1596. ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The
  1597. default is "grub-efi", but "systemd-boot" can be used instead.
  1598. See the :ref:`systemd-boot <ref-classes-systemd-boot>` and
  1599. :ref:`image-live <ref-classes-image-live>` classes for more
  1600. information.
  1601. :term:`ENABLE_BINARY_LOCALE_GENERATION`
  1602. Variable that controls which locales for ``glibc`` are generated
  1603. during the build (useful if the target device has 64Mbytes of RAM or
  1604. less).
  1605. :term:`ERR_REPORT_DIR`
  1606. When used with the :ref:`report-error <ref-classes-report-error>`
  1607. class, specifies the path used for storing the debug files created by
  1608. the :ref:`error reporting
  1609. tool <dev-manual/common-tasks:using the error reporting tool>`, which
  1610. allows you to submit build errors you encounter to a central
  1611. database. By default, the value of this variable is
  1612. ``${``\ :term:`LOG_DIR`\ ``}/error-report``.
  1613. You can set ``ERR_REPORT_DIR`` to the path you want the error
  1614. reporting tool to store the debug files as follows in your
  1615. ``local.conf`` file:
  1616. ::
  1617. ERR_REPORT_DIR = "path"
  1618. :term:`ERROR_QA`
  1619. Specifies the quality assurance checks whose failures are reported as
  1620. errors by the OpenEmbedded build system. You set this variable in
  1621. your distribution configuration file. For a list of the checks you
  1622. can control with this variable, see the
  1623. ":ref:`insane.bbclass <ref-classes-insane>`" section.
  1624. :term:`EXCLUDE_FROM_SHLIBS`
  1625. Triggers the OpenEmbedded build system's shared libraries resolver to
  1626. exclude an entire package when scanning for shared libraries.
  1627. .. note::
  1628. The shared libraries resolver's functionality results in part from
  1629. the internal function ``package_do_shlibs``, which is part of the
  1630. :ref:`ref-tasks-package` task. You should be aware that the shared
  1631. libraries resolver might implicitly define some dependencies between
  1632. packages.
  1633. The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the
  1634. :term:`PRIVATE_LIBS` variable, which excludes a
  1635. package's particular libraries only and not the whole package.
  1636. Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a
  1637. particular package:
  1638. ::
  1639. EXCLUDE_FROM_SHLIBS = "1"
  1640. :term:`EXCLUDE_FROM_WORLD`
  1641. Directs BitBake to exclude a recipe from world builds (i.e.
  1642. ``bitbake world``). During world builds, BitBake locates, parses and
  1643. builds all recipes found in every layer exposed in the
  1644. ``bblayers.conf`` configuration file.
  1645. To exclude a recipe from a world build using this variable, set the
  1646. variable to "1" in the recipe.
  1647. .. note::
  1648. Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a
  1649. world build in order to satisfy dependencies of other recipes. Adding
  1650. a recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not
  1651. explicitly added to the list of build targets in a world build.
  1652. :term:`EXTENDPE`
  1653. Used with file and pathnames to create a prefix for a recipe's
  1654. version based on the recipe's :term:`PE` value. If ``PE``
  1655. is set and greater than zero for a recipe, ``EXTENDPE`` becomes that
  1656. value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1").
  1657. If a recipe's ``PE`` is not set (the default) or is equal to zero,
  1658. ``EXTENDPE`` becomes "".
  1659. See the :term:`STAMP` variable for an example.
  1660. :term:`EXTENDPKGV`
  1661. The full package version specification as it appears on the final
  1662. packages produced by a recipe. The variable's value is normally used
  1663. to fix a runtime dependency to the exact same version of another
  1664. package in the same recipe:
  1665. ::
  1666. RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
  1667. The dependency relationships are intended to force the package
  1668. manager to upgrade these types of packages in lock-step.
  1669. :term:`EXTERNAL_KERNEL_TOOLS`
  1670. When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these
  1671. tools are not in the source tree.
  1672. When kernel tools are available in the tree, they are preferred over
  1673. any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS``
  1674. variable tells the OpenEmbedded build system to prefer the installed
  1675. external tools. See the
  1676. :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in
  1677. ``meta/classes`` to see how the variable is used.
  1678. :term:`EXTERNALSRC`
  1679. When inheriting the :ref:`externalsrc <ref-classes-externalsrc>`
  1680. class, this variable points to the source tree, which is outside of
  1681. the OpenEmbedded build system. When set, this variable sets the
  1682. :term:`S` variable, which is what the OpenEmbedded build
  1683. system uses to locate unpacked recipe source code.
  1684. For more information on ``externalsrc.bbclass``, see the
  1685. ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You
  1686. can also find information on how to use this variable in the
  1687. ":ref:`dev-manual/common-tasks:building software from an external source`"
  1688. section in the Yocto Project Development Tasks Manual.
  1689. :term:`EXTERNALSRC_BUILD`
  1690. When inheriting the :ref:`externalsrc <ref-classes-externalsrc>`
  1691. class, this variable points to the directory in which the recipe's
  1692. source code is built, which is outside of the OpenEmbedded build
  1693. system. When set, this variable sets the :term:`B` variable,
  1694. which is what the OpenEmbedded build system uses to locate the Build
  1695. Directory.
  1696. For more information on ``externalsrc.bbclass``, see the
  1697. ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You
  1698. can also find information on how to use this variable in the
  1699. ":ref:`dev-manual/common-tasks:building software from an external source`"
  1700. section in the Yocto Project Development Tasks Manual.
  1701. :term:`EXTRA_AUTORECONF`
  1702. For recipes inheriting the :ref:`autotools <ref-classes-autotools>`
  1703. class, you can use ``EXTRA_AUTORECONF`` to specify extra options to
  1704. pass to the ``autoreconf`` command that is executed during the
  1705. :ref:`ref-tasks-configure` task.
  1706. The default value is "--exclude=autopoint".
  1707. :term:`EXTRA_IMAGE_FEATURES`
  1708. A list of additional features to include in an image. When listing
  1709. more than one feature, separate them with a space.
  1710. Typically, you configure this variable in your ``local.conf`` file,
  1711. which is found in the :term:`Build Directory`.
  1712. Although you can use this variable from within a recipe, best
  1713. practices dictate that you do not.
  1714. .. note::
  1715. To enable primary features from within the image recipe, use the
  1716. :term:`IMAGE_FEATURES` variable.
  1717. Here are some examples of features you can add:
  1718. - "dbg-pkgs" - Adds -dbg packages for all installed packages including
  1719. symbol information for debugging and profiling.
  1720. - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and
  1721. enables post-installation logging. See the 'allow-empty-password' and
  1722. 'post-install-logging' features in the ":ref:`ref-features-image`"
  1723. section for more information.
  1724. - "dev-pkgs" - Adds -dev packages for all installed packages. This is
  1725. useful if you want to develop against the libraries in the image.
  1726. - "read-only-rootfs" - Creates an image whose root filesystem is
  1727. read-only. See the
  1728. ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`"
  1729. section in the Yocto Project Development Tasks Manual for more
  1730. information
  1731. - "tools-debug" - Adds debugging tools such as gdb and strace.
  1732. - "tools-sdk" - Adds development tools such as gcc, make,
  1733. pkgconfig and so forth.
  1734. - "tools-testapps" - Adds useful testing tools
  1735. such as ts_print, aplay, arecord and so forth.
  1736. For a complete list of image features that ships with the Yocto
  1737. Project, see the ":ref:`ref-features-image`" section.
  1738. For an example that shows how to customize your image by using this
  1739. variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
  1740. section in the Yocto Project Development Tasks Manual.
  1741. :term:`EXTRA_IMAGECMD`
  1742. Specifies additional options for the image creation command that has
  1743. been specified in :term:`IMAGE_CMD`. When setting
  1744. this variable, use an override for the associated image type. Here is
  1745. an example:
  1746. ::
  1747. EXTRA_IMAGECMD_ext3 ?= "-i 4096"
  1748. :term:`EXTRA_IMAGEDEPENDS`
  1749. A list of recipes to build that do not provide packages for
  1750. installing into the root filesystem.
  1751. Sometimes a recipe is required to build the final image but is not
  1752. needed in the root filesystem. You can use the ``EXTRA_IMAGEDEPENDS``
  1753. variable to list these recipes and thus specify the dependencies. A
  1754. typical example is a required bootloader in a machine configuration.
  1755. .. note::
  1756. To add packages to the root filesystem, see the various
  1757. \*:term:`RDEPENDS` and \*:term:`RRECOMMENDS` variables.
  1758. :term:`EXTRANATIVEPATH`
  1759. A list of subdirectories of
  1760. ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}``
  1761. added to the beginning of the environment variable ``PATH``. As an
  1762. example, the following prepends
  1763. "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to
  1764. ``PATH``:
  1765. ::
  1766. EXTRANATIVEPATH = "foo bar"
  1767. :term:`EXTRA_OECMAKE`
  1768. Additional `CMake <https://cmake.org/overview/>`__ options. See the
  1769. :ref:`cmake <ref-classes-cmake>` class for additional information.
  1770. :term:`EXTRA_OECONF`
  1771. Additional ``configure`` script options. See
  1772. :term:`PACKAGECONFIG_CONFARGS` for
  1773. additional information on passing configure script options.
  1774. :term:`EXTRA_OEMAKE`
  1775. Additional GNU ``make`` options.
  1776. Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the
  1777. variable to specify any required GNU options.
  1778. :term:`PARALLEL_MAKE` and
  1779. :term:`PARALLEL_MAKEINST` also make use of
  1780. ``EXTRA_OEMAKE`` to pass the required flags.
  1781. :term:`EXTRA_OESCONS`
  1782. When inheriting the :ref:`scons <ref-classes-scons>` class, this
  1783. variable specifies additional configuration options you want to pass
  1784. to the ``scons`` command line.
  1785. :term:`EXTRA_USERS_PARAMS`
  1786. When inheriting the :ref:`extrausers <ref-classes-extrausers>`
  1787. class, this variable provides image level user and group operations.
  1788. This is a more global method of providing user and group
  1789. configuration as compared to using the
  1790. :ref:`useradd <ref-classes-useradd>` class, which ties user and
  1791. group configurations to a specific recipe.
  1792. The set list of commands you can configure using the
  1793. ``EXTRA_USERS_PARAMS`` is shown in the ``extrausers`` class. These
  1794. commands map to the normal Unix commands of the same names:
  1795. ::
  1796. # EXTRA_USERS_PARAMS = "\
  1797. # useradd -p '' tester; \
  1798. # groupadd developers; \
  1799. # userdel nobody; \
  1800. # groupdel -g video; \
  1801. # groupmod -g 1020 developers; \
  1802. # usermod -s /bin/sh tester; \
  1803. # "
  1804. :term:`FEATURE_PACKAGES`
  1805. Defines one or more packages to include in an image when a specific
  1806. item is included in :term:`IMAGE_FEATURES`.
  1807. When setting the value, ``FEATURE_PACKAGES`` should have the name of
  1808. the feature item as an override. Here is an example:
  1809. ::
  1810. FEATURE_PACKAGES_widget = "package1 package2"
  1811. In this example, if "widget" were added to ``IMAGE_FEATURES``,
  1812. package1 and package2 would be included in the image.
  1813. .. note::
  1814. Packages installed by features defined through ``FEATURE_PACKAGES``
  1815. are often package groups. While similarly named, you should not
  1816. confuse the ``FEATURE_PACKAGES`` variable with package groups, which
  1817. are discussed elsewhere in the documentation.
  1818. :term:`FEED_DEPLOYDIR_BASE_URI`
  1819. Points to the base URL of the server and location within the
  1820. document-root that provides the metadata and packages required by
  1821. OPKG to support runtime package management of IPK packages. You set
  1822. this variable in your ``local.conf`` file.
  1823. Consider the following example:
  1824. ::
  1825. FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir"
  1826. This example assumes you are serving
  1827. your packages over HTTP and your databases are located in a directory
  1828. named ``BOARD-dir``, which is underneath your HTTP server's
  1829. document-root. In this case, the OpenEmbedded build system generates
  1830. a set of configuration files for you in your target that work with
  1831. the feed.
  1832. :term:`FILES`
  1833. The list of files and directories that are placed in a package. The
  1834. :term:`PACKAGES` variable lists the packages
  1835. generated by a recipe.
  1836. To use the ``FILES`` variable, provide a package name override that
  1837. identifies the resulting package. Then, provide a space-separated
  1838. list of files or paths that identify the files you want included as
  1839. part of the resulting package. Here is an example:
  1840. ::
  1841. FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile"
  1842. .. note::
  1843. - When specifying files or paths, you can pattern match using
  1844. Python's
  1845. `glob <https://docs.python.org/3/library/glob.html>`_
  1846. syntax. For details on the syntax, see the documentation by
  1847. following the previous link.
  1848. - When specifying paths as part of the ``FILES`` variable, it is
  1849. good practice to use appropriate path variables. For example,
  1850. use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}``
  1851. rather than ``/usr/bin``. You can find a list of these
  1852. variables at the top of the ``meta/conf/bitbake.conf`` file in
  1853. the :term:`Source Directory`. You will also
  1854. find the default values of the various ``FILES_*`` variables in
  1855. this file.
  1856. If some of the files you provide with the ``FILES`` variable are
  1857. editable and you know they should not be overwritten during the
  1858. package update process by the Package Management System (PMS), you
  1859. can identify these files so that the PMS will not overwrite them. See
  1860. the :term:`CONFFILES` variable for information on
  1861. how to identify these files to the PMS.
  1862. :term:`FILES_SOLIBSDEV`
  1863. Defines the file specification to match
  1864. :term:`SOLIBSDEV`. In other words,
  1865. ``FILES_SOLIBSDEV`` defines the full path name of the development
  1866. symbolic link (symlink) for shared libraries on the target platform.
  1867. The following statement from the ``bitbake.conf`` shows how it is
  1868. set:
  1869. ::
  1870. FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}"
  1871. :term:`FILESEXTRAPATHS`
  1872. Extends the search path the OpenEmbedded build system uses when
  1873. looking for files and patches as it processes recipes and append
  1874. files. The default directories BitBake uses when it processes recipes
  1875. are initially defined by the :term:`FILESPATH`
  1876. variable. You can extend ``FILESPATH`` variable by using
  1877. ``FILESEXTRAPATHS``.
  1878. Best practices dictate that you accomplish this by using
  1879. ``FILESEXTRAPATHS`` from within a ``.bbappend`` file and that you
  1880. prepend paths as follows:
  1881. ::
  1882. FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
  1883. In the above example, the build system first
  1884. looks for files in a directory that has the same name as the
  1885. corresponding append file.
  1886. .. note::
  1887. When extending ``FILESEXTRAPATHS``, be sure to use the immediate
  1888. expansion (``:=``) operator. Immediate expansion makes sure that
  1889. BitBake evaluates :term:`THISDIR` at the time the
  1890. directive is encountered rather than at some later time when
  1891. expansion might result in a directory that does not contain the
  1892. files you need.
  1893. Also, include the trailing separating colon character if you are
  1894. prepending. The trailing colon character is necessary because you
  1895. are directing BitBake to extend the path by prepending directories
  1896. to the search path.
  1897. Here is another common use:
  1898. ::
  1899. FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
  1900. In this example, the build system extends the
  1901. ``FILESPATH`` variable to include a directory named ``files`` that is
  1902. in the same directory as the corresponding append file.
  1903. This next example specifically adds three paths:
  1904. ::
  1905. FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
  1906. A final example shows how you can extend the search path and include
  1907. a :term:`MACHINE`-specific override, which is useful
  1908. in a BSP layer:
  1909. ::
  1910. FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:"
  1911. The previous statement appears in the
  1912. ``linux-yocto-dev.bbappend`` file, which is found in the
  1913. :ref:`overview-manual/development-environment:yocto project source repositories` in
  1914. ``meta-intel/common/recipes-kernel/linux``. Here, the machine
  1915. override is a special :term:`PACKAGE_ARCH`
  1916. definition for multiple ``meta-intel`` machines.
  1917. .. note::
  1918. For a layer that supports a single BSP, the override could just be
  1919. the value of ``MACHINE``.
  1920. By prepending paths in ``.bbappend`` files, you allow multiple append
  1921. files that reside in different layers but are used for the same
  1922. recipe to correctly extend the path.
  1923. :term:`FILESOVERRIDES`
  1924. A subset of :term:`OVERRIDES` used by the
  1925. OpenEmbedded build system for creating
  1926. :term:`FILESPATH`. The ``FILESOVERRIDES`` variable
  1927. uses overrides to automatically extend the
  1928. :term:`FILESPATH` variable. For an example of how
  1929. that works, see the :term:`FILESPATH` variable
  1930. description. Additionally, you find more information on how overrides
  1931. are handled in the
  1932. ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
  1933. section of the BitBake User Manual.
  1934. By default, the ``FILESOVERRIDES`` variable is defined as:
  1935. ::
  1936. FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}"
  1937. .. note::
  1938. Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up
  1939. with expected overrides and are used in an expected manner by the
  1940. build system.
  1941. :term:`FILESPATH`
  1942. The default set of directories the OpenEmbedded build system uses
  1943. when searching for patches and files.
  1944. During the build process, BitBake searches each directory in
  1945. ``FILESPATH`` in the specified order when looking for files and
  1946. patches specified by each ``file://`` URI in a recipe's
  1947. :term:`SRC_URI` statements.
  1948. The default value for the ``FILESPATH`` variable is defined in the
  1949. ``base.bbclass`` class found in ``meta/classes`` in the
  1950. :term:`Source Directory`:
  1951. ::
  1952. FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
  1953. "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
  1954. The
  1955. ``FILESPATH`` variable is automatically extended using the overrides
  1956. from the :term:`FILESOVERRIDES` variable.
  1957. .. note::
  1958. - Do not hand-edit the ``FILESPATH`` variable. If you want the
  1959. build system to look in directories other than the defaults,
  1960. extend the ``FILESPATH`` variable by using the
  1961. :term:`FILESEXTRAPATHS` variable.
  1962. - Be aware that the default ``FILESPATH`` directories do not map
  1963. to directories in custom layers where append files
  1964. (``.bbappend``) are used. If you want the build system to find
  1965. patches or files that reside with your append files, you need
  1966. to extend the ``FILESPATH`` variable by using the
  1967. ``FILESEXTRAPATHS`` variable.
  1968. You can take advantage of this searching behavior in useful ways. For
  1969. example, consider a case where the following directory structure
  1970. exists for general and machine-specific configurations:
  1971. ::
  1972. files/defconfig
  1973. files/MACHINEA/defconfig
  1974. files/MACHINEB/defconfig
  1975. Also in the example, the ``SRC_URI`` statement contains
  1976. "file://defconfig". Given this scenario, you can set
  1977. :term:`MACHINE` to "MACHINEA" and cause the build
  1978. system to use files from ``files/MACHINEA``. Set ``MACHINE`` to
  1979. "MACHINEB" and the build system uses files from ``files/MACHINEB``.
  1980. Finally, for any machine other than "MACHINEA" and "MACHINEB", the
  1981. build system uses files from ``files/defconfig``.
  1982. You can find out more about the patching process in the
  1983. ":ref:`overview-manual/concepts:patching`" section
  1984. in the Yocto Project Overview and Concepts Manual and the
  1985. ":ref:`dev-manual/common-tasks:patching code`" section in
  1986. the Yocto Project Development Tasks Manual. See the
  1987. :ref:`ref-tasks-patch` task as well.
  1988. :term:`FILESYSTEM_PERMS_TABLES`
  1989. Allows you to define your own file permissions settings table as part
  1990. of your configuration for the packaging process. For example, suppose
  1991. you need a consistent set of custom permissions for a set of groups
  1992. and users across an entire work project. It is best to do this in the
  1993. packages themselves but this is not always possible.
  1994. By default, the OpenEmbedded build system uses the ``fs-perms.txt``,
  1995. which is located in the ``meta/files`` folder in the :term:`Source Directory`.
  1996. If you create your own file
  1997. permissions setting table, you should place it in your layer or the
  1998. distro's layer.
  1999. You define the ``FILESYSTEM_PERMS_TABLES`` variable in the
  2000. ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
  2001. to point to your custom
  2002. ``fs-perms.txt``. You can specify more than a single file permissions
  2003. setting table. The paths you specify to these files must be defined
  2004. within the :term:`BBPATH` variable.
  2005. For guidance on how to create your own file permissions settings
  2006. table file, examine the existing ``fs-perms.txt``.
  2007. :term:`FIT_DESC`
  2008. Specifies the description string encoded into a fitImage. The default
  2009. value is set by the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>`
  2010. class as follows::
  2011. FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}"
  2012. :term:`FIT_GENERATE_KEYS`
  2013. Decides whether to generate the keys for signing fitImage if they
  2014. don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``.
  2015. The default value is 0.
  2016. :term:`FIT_HASH_ALG`
  2017. Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256.
  2018. :term:`FIT_KEY_GENRSA_ARGS`
  2019. Arguments to openssl genrsa for generating RSA private key for signing
  2020. fitImage. The default value is "-F4". i.e. the public exponent 65537 to
  2021. use.
  2022. :term:`FIT_KEY_REQ_ARGS`
  2023. Arguments to openssl req for generating certificate for signing fitImage.
  2024. The default value is "-batch -new". batch for non interactive mode
  2025. and new for generating new keys.
  2026. :term:`FIT_KEY_SIGN_PKCS`
  2027. Format for public key ceritifcate used in signing fitImage.
  2028. The default value is "x509".
  2029. :term:`FIT_SIGN_ALG`
  2030. Specifies the signature algorithm used in creating the FIT Image.
  2031. For e.g. rsa2048.
  2032. :term:`FIT_SIGN_NUMBITS`
  2033. Size of private key in number of bits used in fitImage. The default
  2034. value is "2048".
  2035. :term:`FIT_SIGN_INDIVIDUAL`
  2036. If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>`
  2037. class will sign the kernel, dtb and ramdisk images individually in addition
  2038. to signing the fitImage itself. This could be useful if you are
  2039. intending to verify signatures in another context than booting via
  2040. U-Boot.
  2041. :term:`FONT_EXTRA_RDEPENDS`
  2042. When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
  2043. this variable specifies the runtime dependencies for font packages.
  2044. By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils".
  2045. :term:`FONT_PACKAGES`
  2046. When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
  2047. this variable identifies packages containing font files that need to
  2048. be cached by Fontconfig. By default, the ``fontcache`` class assumes
  2049. that fonts are in the recipe's main package (i.e.
  2050. ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
  2051. need are in a package other than that main package.
  2052. :term:`FORCE_RO_REMOVE`
  2053. Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED``
  2054. during the generation of the root filesystem.
  2055. Set the variable to "1" to force the removal of these packages.
  2056. :term:`FULL_OPTIMIZATION`
  2057. The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when
  2058. compiling an optimized system. This variable defaults to "-O2 -pipe
  2059. ${DEBUG_FLAGS}".
  2060. :term:`GCCPIE`
  2061. Enables Position Independent Executables (PIE) within the GNU C
  2062. Compiler (GCC). Enabling PIE in the GCC makes Return Oriented
  2063. Programming (ROP) attacks much more difficult to execute.
  2064. By default the ``security_flags.inc`` file enables PIE by setting the
  2065. variable as follows:
  2066. ::
  2067. GCCPIE ?= "--enable-default-pie"
  2068. :term:`GCCVERSION`
  2069. Specifies the default version of the GNU C Compiler (GCC) used for
  2070. compilation. By default, ``GCCVERSION`` is set to "8.x" in the
  2071. ``meta/conf/distro/include/tcmode-default.inc`` include file:
  2072. ::
  2073. GCCVERSION ?= "8.%"
  2074. You can override this value by setting it in a
  2075. configuration file such as the ``local.conf``.
  2076. :term:`GDB`
  2077. The minimal command and arguments to run the GNU Debugger.
  2078. :term:`GITDIR`
  2079. The directory in which a local copy of a Git repository is stored
  2080. when it is cloned.
  2081. :term:`GLIBC_GENERATE_LOCALES`
  2082. Specifies the list of GLIBC locales to generate should you not wish
  2083. to generate all LIBC locals, which can be time consuming.
  2084. .. note::
  2085. If you specifically remove the locale ``en_US.UTF-8``, you must set
  2086. :term:`IMAGE_LINGUAS` appropriately.
  2087. You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file.
  2088. By default, all locales are generated.
  2089. ::
  2090. GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8"
  2091. :term:`GROUPADD_PARAM`
  2092. When inheriting the :ref:`useradd <ref-classes-useradd>` class,
  2093. this variable specifies for a package what parameters should be
  2094. passed to the ``groupadd`` command if you wish to add a group to the
  2095. system when the package is installed.
  2096. Here is an example from the ``dbus`` recipe:
  2097. ::
  2098. GROUPADD_PARAM_${PN} = "-r netdev"
  2099. For information on the standard Linux shell command
  2100. ``groupadd``, see https://linux.die.net/man/8/groupadd.
  2101. :term:`GROUPMEMS_PARAM`
  2102. When inheriting the :ref:`useradd <ref-classes-useradd>` class,
  2103. this variable specifies for a package what parameters should be
  2104. passed to the ``groupmems`` command if you wish to modify the members
  2105. of a group when the package is installed.
  2106. For information on the standard Linux shell command ``groupmems``,
  2107. see https://linux.die.net/man/8/groupmems.
  2108. :term:`GRUB_GFXSERIAL`
  2109. Configures the GNU GRand Unified Bootloader (GRUB) to have graphics
  2110. and serial in the boot menu. Set this variable to "1" in your
  2111. ``local.conf`` or distribution configuration file to enable graphics
  2112. and serial in the menu.
  2113. See the :ref:`grub-efi <ref-classes-grub-efi>` class for more
  2114. information on how this variable is used.
  2115. :term:`GRUB_OPTS`
  2116. Additional options to add to the GNU GRand Unified Bootloader (GRUB)
  2117. configuration. Use a semi-colon character (``;``) to separate
  2118. multiple options.
  2119. The ``GRUB_OPTS`` variable is optional. See the
  2120. :ref:`grub-efi <ref-classes-grub-efi>` class for more information
  2121. on how this variable is used.
  2122. :term:`GRUB_TIMEOUT`
  2123. Specifies the timeout before executing the default ``LABEL`` in the
  2124. GNU GRand Unified Bootloader (GRUB).
  2125. The ``GRUB_TIMEOUT`` variable is optional. See the
  2126. :ref:`grub-efi <ref-classes-grub-efi>` class for more information
  2127. on how this variable is used.
  2128. :term:`GTKIMMODULES_PACKAGES`
  2129. When inheriting the
  2130. :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class,
  2131. this variable specifies the packages that contain the GTK+ input
  2132. method modules being installed when the modules are in packages other
  2133. than the main package.
  2134. :term:`HOMEPAGE`
  2135. Website where more information about the software the recipe is
  2136. building can be found.
  2137. :term:`HOST_ARCH`
  2138. The name of the target architecture, which is normally the same as
  2139. :term:`TARGET_ARCH`. The OpenEmbedded build system
  2140. supports many architectures. Here is an example list of architectures
  2141. supported. This list is by no means complete as the architecture is
  2142. configurable:
  2143. - arm
  2144. - i586
  2145. - x86_64
  2146. - powerpc
  2147. - powerpc64
  2148. - mips
  2149. - mipsel
  2150. :term:`HOST_CC_ARCH`
  2151. Specifies architecture-specific compiler flags that are passed to the
  2152. C compiler.
  2153. Default initialization for ``HOST_CC_ARCH`` varies depending on what
  2154. is being built:
  2155. - :term:`TARGET_CC_ARCH` when building for the
  2156. target
  2157. - :term:`BUILD_CC_ARCH` when building for the build host (i.e.
  2158. ``-native``)
  2159. - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e.
  2160. ``nativesdk-``)
  2161. :term:`HOST_OS`
  2162. Specifies the name of the target operating system, which is normally
  2163. the same as the :term:`TARGET_OS`. The variable can
  2164. be set to "linux" for ``glibc``-based systems and to "linux-musl" for
  2165. ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and
  2166. "linux-musleabi" values possible.
  2167. :term:`HOST_PREFIX`
  2168. Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX``
  2169. is normally the same as :term:`TARGET_PREFIX`.
  2170. :term:`HOST_SYS`
  2171. Specifies the system, including the architecture and the operating
  2172. system, for which the build is occurring in the context of the
  2173. current recipe.
  2174. The OpenEmbedded build system automatically sets this variable based
  2175. on :term:`HOST_ARCH`,
  2176. :term:`HOST_VENDOR`, and
  2177. :term:`HOST_OS` variables.
  2178. .. note::
  2179. You do not need to set the variable yourself.
  2180. Consider these two examples:
  2181. - Given a native recipe on a 32-bit x86 machine running Linux, the
  2182. value is "i686-linux".
  2183. - Given a recipe being built for a little-endian MIPS target running
  2184. Linux, the value might be "mipsel-linux".
  2185. :term:`HOSTTOOLS`
  2186. A space-separated list (filter) of tools on the build host that
  2187. should be allowed to be called from within build tasks. Using this
  2188. filter helps reduce the possibility of host contamination. If a tool
  2189. specified in the value of ``HOSTTOOLS`` is not found on the build
  2190. host, the OpenEmbedded build system produces an error and the build
  2191. is not started.
  2192. For additional information, see
  2193. :term:`HOSTTOOLS_NONFATAL`.
  2194. :term:`HOSTTOOLS_NONFATAL`
  2195. A space-separated list (filter) of tools on the build host that
  2196. should be allowed to be called from within build tasks. Using this
  2197. filter helps reduce the possibility of host contamination. Unlike
  2198. :term:`HOSTTOOLS`, the OpenEmbedded build system
  2199. does not produce an error if a tool specified in the value of
  2200. ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can
  2201. use ``HOSTTOOLS_NONFATAL`` to filter optional host tools.
  2202. :term:`HOST_VENDOR`
  2203. Specifies the name of the vendor. ``HOST_VENDOR`` is normally the
  2204. same as :term:`TARGET_VENDOR`.
  2205. :term:`ICECC_DISABLED`
  2206. Disables or enables the ``icecc`` (Icecream) function. For more
  2207. information on this function and best practices for using this
  2208. variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`"
  2209. section.
  2210. Setting this variable to "1" in your ``local.conf`` disables the
  2211. function:
  2212. ::
  2213. ICECC_DISABLED ??= "1"
  2214. To enable the function, set the variable as follows:
  2215. ::
  2216. ICECC_DISABLED = ""
  2217. :term:`ICECC_ENV_EXEC`
  2218. Points to the ``icecc-create-env`` script that you provide. This
  2219. variable is used by the :ref:`icecc <ref-classes-icecc>` class. You
  2220. set this variable in your ``local.conf`` file.
  2221. If you do not point to a script that you provide, the OpenEmbedded
  2222. build system uses the default script provided by the
  2223. ``icecc-create-env.bb`` recipe, which is a modified version and not
  2224. the one that comes with ``icecc``.
  2225. :term:`ICECC_PARALLEL_MAKE`
  2226. Extra options passed to the ``make`` command during the
  2227. :ref:`ref-tasks-compile` task that specify parallel
  2228. compilation. This variable usually takes the form of "-j x", where x
  2229. represents the maximum number of parallel threads ``make`` can run.
  2230. .. note::
  2231. The options passed affect builds on all enabled machines on the
  2232. network, which are machines running the ``iceccd`` daemon.
  2233. If your enabled machines support multiple cores, coming up with the
  2234. maximum number of parallel threads that gives you the best
  2235. performance could take some experimentation since machine speed,
  2236. network lag, available memory, and existing machine loads can all
  2237. affect build time. Consequently, unlike the
  2238. :term:`PARALLEL_MAKE` variable, there is no
  2239. rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal
  2240. performance.
  2241. If you do not set ``ICECC_PARALLEL_MAKE``, the build system does not
  2242. use it (i.e. the system does not detect and assign the number of
  2243. cores as is done with ``PARALLEL_MAKE``).
  2244. :term:`ICECC_PATH`
  2245. The location of the ``icecc`` binary. You can set this variable in
  2246. your ``local.conf`` file. If your ``local.conf`` file does not define
  2247. this variable, the :ref:`icecc <ref-classes-icecc>` class attempts
  2248. to define it by locating ``icecc`` using ``which``.
  2249. :term:`ICECC_USER_CLASS_BL`
  2250. Identifies user classes that you do not want the Icecream distributed
  2251. compile support to consider. This variable is used by the
  2252. :ref:`icecc <ref-classes-icecc>` class. You set this variable in
  2253. your ``local.conf`` file.
  2254. When you list classes using this variable, you are "blacklisting"
  2255. them from distributed compilation across remote hosts. Any classes
  2256. you list will be distributed and compiled locally.
  2257. :term:`ICECC_USER_PACKAGE_BL`
  2258. Identifies user recipes that you do not want the Icecream distributed
  2259. compile support to consider. This variable is used by the
  2260. :ref:`icecc <ref-classes-icecc>` class. You set this variable in
  2261. your ``local.conf`` file.
  2262. When you list packages using this variable, you are "blacklisting"
  2263. them from distributed compilation across remote hosts. Any packages
  2264. you list will be distributed and compiled locally.
  2265. :term:`ICECC_USER_PACKAGE_WL`
  2266. Identifies user recipes that use an empty
  2267. :term:`PARALLEL_MAKE` variable that you want to
  2268. force remote distributed compilation on using the Icecream
  2269. distributed compile support. This variable is used by the
  2270. :ref:`icecc <ref-classes-icecc>` class. You set this variable in
  2271. your ``local.conf`` file.
  2272. :term:`IMAGE_BASENAME`
  2273. The base name of image output files. This variable defaults to the
  2274. recipe name (``${``\ :term:`PN`\ ``}``).
  2275. :term:`IMAGE_EFI_BOOT_FILES`
  2276. A space-separated list of files installed into the boot partition
  2277. when preparing an image using the Wic tool with the
  2278. ``bootimg-efi`` source plugin. By default,
  2279. the files are
  2280. installed under the same name as the source files. To change the
  2281. installed name, separate it from the original name with a semi-colon
  2282. (;). Source files need to be located in
  2283. :term:`DEPLOY_DIR_IMAGE`. Here are two
  2284. examples:
  2285. ::
  2286. IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2"
  2287. IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio"
  2288. Alternatively, source files can be picked up using a glob pattern. In
  2289. this case, the destination file must have the same name as the base
  2290. name of the source file path. To install files into a directory
  2291. within the target location, pass its name after a semi-colon (;).
  2292. Here are two examples:
  2293. ::
  2294. IMAGE_EFI_BOOT_FILES = "boot/loader/*"
  2295. IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/"
  2296. The first example
  2297. installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/``
  2298. into the root of the target partition. The second example installs
  2299. the same files into a ``boot`` directory within the target partition.
  2300. You can find information on how to use the Wic tool in the
  2301. ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
  2302. section of the Yocto Project Development Tasks Manual. Reference
  2303. material for Wic is located in the
  2304. ":doc:`/ref-manual/kickstart`" chapter.
  2305. :term:`IMAGE_BOOT_FILES`
  2306. A space-separated list of files installed into the boot partition
  2307. when preparing an image using the Wic tool with the
  2308. ``bootimg-partition`` source plugin. By default,
  2309. the files are
  2310. installed under the same name as the source files. To change the
  2311. installed name, separate it from the original name with a semi-colon
  2312. (;). Source files need to be located in
  2313. :term:`DEPLOY_DIR_IMAGE`. Here are two
  2314. examples:
  2315. ::
  2316. IMAGE_BOOT_FILES = "u-boot.img uImage;kernel"
  2317. IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}"
  2318. Alternatively, source files can be picked up using a glob pattern. In
  2319. this case, the destination file must have the same name as the base
  2320. name of the source file path. To install files into a directory
  2321. within the target location, pass its name after a semi-colon (;).
  2322. Here are two examples:
  2323. ::
  2324. IMAGE_BOOT_FILES = "bcm2835-bootfiles/*"
  2325. IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/"
  2326. The first example
  2327. installs all files from ``${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles``
  2328. into the root of the target partition. The second example installs
  2329. the same files into a ``boot`` directory within the target partition.
  2330. You can find information on how to use the Wic tool in the
  2331. ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
  2332. section of the Yocto Project Development Tasks Manual. Reference
  2333. material for Wic is located in the
  2334. ":doc:`/ref-manual/kickstart`" chapter.
  2335. :term:`IMAGE_CLASSES`
  2336. A list of classes that all images should inherit. You typically use
  2337. this variable to specify the list of classes that register the
  2338. different types of images the OpenEmbedded build system creates.
  2339. The default value for ``IMAGE_CLASSES`` is ``image_types``. You can
  2340. set this variable in your ``local.conf`` or in a distribution
  2341. configuration file.
  2342. For more information, see ``meta/classes/image_types.bbclass`` in the
  2343. :term:`Source Directory`.
  2344. :term:`IMAGE_CMD`
  2345. Specifies the command to create the image file for a specific image
  2346. type, which corresponds to the value set set in
  2347. :term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
  2348. ``btrfs``, and so forth). When setting this variable, you should use
  2349. an override for the associated type. Here is an example:
  2350. ::
  2351. IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
  2352. --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
  2353. ${EXTRA_IMAGECMD}"
  2354. You typically do not need to set this variable unless you are adding
  2355. support for a new image type. For more examples on how to set this
  2356. variable, see the :ref:`image_types <ref-classes-image_types>`
  2357. class file, which is ``meta/classes/image_types.bbclass``.
  2358. :term:`IMAGE_DEVICE_TABLES`
  2359. Specifies one or more files that contain custom device tables that
  2360. are passed to the ``makedevs`` command as part of creating an image.
  2361. These files list basic device nodes that should be created under
  2362. ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set,
  2363. ``files/device_table-minimal.txt`` is used, which is located by
  2364. :term:`BBPATH`. For details on how you should write
  2365. device table files, see ``meta/files/device_table-minimal.txt`` as an
  2366. example.
  2367. :term:`IMAGE_FEATURES`
  2368. The primary list of features to include in an image. Typically, you
  2369. configure this variable in an image recipe. Although you can use this
  2370. variable from your ``local.conf`` file, which is found in the
  2371. :term:`Build Directory`, best practices dictate that you do
  2372. not.
  2373. .. note::
  2374. To enable extra features from outside the image recipe, use the
  2375. :term:`EXTRA_IMAGE_FEATURES` variable.
  2376. For a list of image features that ships with the Yocto Project, see
  2377. the ":ref:`ref-features-image`" section.
  2378. For an example that shows how to customize your image by using this
  2379. variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
  2380. section in the Yocto Project Development Tasks Manual.
  2381. :term:`IMAGE_FSTYPES`
  2382. Specifies the formats the OpenEmbedded build system uses during the
  2383. build when creating the root filesystem. For example, setting
  2384. ``IMAGE_FSTYPES`` as follows causes the build system to create root
  2385. filesystems using two formats: ``.ext3`` and ``.tar.bz2``:
  2386. ::
  2387. IMAGE_FSTYPES = "ext3 tar.bz2"
  2388. For the complete list of supported image formats from which you can
  2389. choose, see :term:`IMAGE_TYPES`.
  2390. .. note::
  2391. - If an image recipe uses the "inherit image" line and you are
  2392. setting ``IMAGE_FSTYPES`` inside the recipe, you must set
  2393. ``IMAGE_FSTYPES`` prior to using the "inherit image" line.
  2394. - Due to the way the OpenEmbedded build system processes this
  2395. variable, you cannot update its contents by using ``_append``
  2396. or ``_prepend``. You must use the ``+=`` operator to add one or
  2397. more options to the ``IMAGE_FSTYPES`` variable.
  2398. :term:`IMAGE_INSTALL`
  2399. Used by recipes to specify the packages to install into an image
  2400. through the :ref:`image <ref-classes-image>` class. Use the
  2401. ``IMAGE_INSTALL`` variable with care to avoid ordering issues.
  2402. Image recipes set ``IMAGE_INSTALL`` to specify the packages to
  2403. install into an image through ``image.bbclass``. Additionally,
  2404. "helper" classes such as the
  2405. :ref:`core-image <ref-classes-core-image>` class exist that can
  2406. take lists used with ``IMAGE_FEATURES`` and turn them into
  2407. auto-generated entries in ``IMAGE_INSTALL`` in addition to its
  2408. default contents.
  2409. When you use this variable, it is best to use it as follows:
  2410. ::
  2411. IMAGE_INSTALL_append = " package-name"
  2412. Be sure to include the space
  2413. between the quotation character and the start of the package name or
  2414. names.
  2415. .. note::
  2416. - When working with a
  2417. :ref:`core-image-minimal-initramfs <ref-manual/images:images>`
  2418. image, do not use the ``IMAGE_INSTALL`` variable to specify
  2419. packages for installation. Instead, use the
  2420. :term:`PACKAGE_INSTALL` variable, which
  2421. allows the initial RAM filesystem (initramfs) recipe to use a
  2422. fixed set of packages and not be affected by ``IMAGE_INSTALL``.
  2423. For information on creating an initramfs, see the
  2424. ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`"
  2425. section in the Yocto Project Development Tasks Manual.
  2426. - Using ``IMAGE_INSTALL`` with the
  2427. :ref:`+= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>`
  2428. BitBake operator within the ``/conf/local.conf`` file or from
  2429. within an image recipe is not recommended. Use of this operator
  2430. in these ways can cause ordering issues. Since
  2431. ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default
  2432. value using the
  2433. :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>`
  2434. operator, using a ``+=`` operation against ``IMAGE_INSTALL``
  2435. results in unexpected behavior when used within
  2436. ``conf/local.conf``. Furthermore, the same operation from
  2437. within an image recipe may or may not succeed depending on the
  2438. specific situation. In both these cases, the behavior is
  2439. contrary to how most users expect the ``+=`` operator to work.
  2440. :term:`IMAGE_LINGUAS`
  2441. Specifies the list of locales to install into the image during the
  2442. root filesystem construction process. The OpenEmbedded build system
  2443. automatically splits locale files, which are used for localization,
  2444. into separate packages. Setting the ``IMAGE_LINGUAS`` variable
  2445. ensures that any locale packages that correspond to packages already
  2446. selected for installation into the image are also installed. Here is
  2447. an example:
  2448. ::
  2449. IMAGE_LINGUAS = "pt-br de-de"
  2450. In this example, the build system ensures any Brazilian Portuguese
  2451. and German locale files that correspond to packages in the image are
  2452. installed (i.e. ``*-locale-pt-br`` and ``*-locale-de-de`` as well as
  2453. ``*-locale-pt`` and ``*-locale-de``, since some software packages
  2454. only provide locale files by language and not by country-specific
  2455. language).
  2456. See the :term:`GLIBC_GENERATE_LOCALES`
  2457. variable for information on generating GLIBC locales.
  2458. :term:`IMAGE_LINK_NAME`
  2459. The name of the output image symlink (which does not include
  2460. the version part as :term:`IMAGE_NAME` does). The default value
  2461. is derived using the :term:`IMAGE_BASENAME` and :term:`MACHINE`
  2462. variables:
  2463. ::
  2464. IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}-${MACHINE}"
  2465. :term:`IMAGE_MANIFEST`
  2466. The manifest file for the image. This file lists all the installed
  2467. packages that make up the image. The file contains package
  2468. information on a line-per-package basis as follows:
  2469. ::
  2470. packagename packagearch version
  2471. The :ref:`image <ref-classes-image>` class defines the manifest
  2472. file as follows:
  2473. ::
  2474. IMAGE_MANIFEST ="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest"
  2475. The location is
  2476. derived using the :term:`DEPLOY_DIR_IMAGE`
  2477. and :term:`IMAGE_NAME` variables. You can find
  2478. information on how the image is created in the ":ref:`overview-manual/concepts:image generation`"
  2479. section in the Yocto Project Overview and Concepts Manual.
  2480. :term:`IMAGE_NAME`
  2481. The name of the output image files minus the extension. This variable
  2482. is derived using the :term:`IMAGE_BASENAME`,
  2483. :term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX`
  2484. variables:
  2485. ::
  2486. IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  2487. :term:`IMAGE_NAME_SUFFIX`
  2488. Suffix used for the image output file name - defaults to ``".rootfs"``
  2489. to distinguish the image file from other files created during image
  2490. building; however if this suffix is redundant or not desired you can
  2491. clear the value of this variable (set the value to ""). For example,
  2492. this is typically cleared in initramfs image recipes.
  2493. :term:`IMAGE_OVERHEAD_FACTOR`
  2494. Defines a multiplier that the build system applies to the initial
  2495. image size for cases when the multiplier times the returned disk
  2496. usage value for the image is greater than the sum of
  2497. ``IMAGE_ROOTFS_SIZE`` and ``IMAGE_ROOTFS_EXTRA_SPACE``. The result of
  2498. the multiplier applied to the initial image size creates free disk
  2499. space in the image as overhead. By default, the build process uses a
  2500. multiplier of 1.3 for this variable. This default value results in
  2501. 30% free disk space added to the image when this method is used to
  2502. determine the final generated image size. You should be aware that
  2503. post install scripts and the package management system uses disk
  2504. space inside this overhead area. Consequently, the multiplier does
  2505. not produce an image with all the theoretical free disk space. See
  2506. ``IMAGE_ROOTFS_SIZE`` for information on how the build system
  2507. determines the overall image size.
  2508. The default 30% free disk space typically gives the image enough room
  2509. to boot and allows for basic post installs while still leaving a
  2510. small amount of free disk space. If 30% free space is inadequate, you
  2511. can increase the default value. For example, the following setting
  2512. gives you 50% free space added to the image:
  2513. ::
  2514. IMAGE_OVERHEAD_FACTOR = "1.5"
  2515. Alternatively, you can ensure a specific amount of free disk space is
  2516. added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE``
  2517. variable.
  2518. :term:`IMAGE_PKGTYPE`
  2519. Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the
  2520. OpenEmbedded build system. The variable is defined appropriately by
  2521. the :ref:`package_deb <ref-classes-package_deb>`,
  2522. :ref:`package_rpm <ref-classes-package_rpm>`,
  2523. :ref:`package_ipk <ref-classes-package_ipk>`, or
  2524. :ref:`package_tar <ref-classes-package_tar>` class.
  2525. .. note::
  2526. The ``package_tar`` class is broken and is not supported. It is
  2527. recommended that you do not use it.
  2528. The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and
  2529. :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE``
  2530. for packaging up images and SDKs.
  2531. You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the
  2532. variable is set indirectly through the appropriate
  2533. :ref:`package_* <ref-classes-package>` class using the
  2534. :term:`PACKAGE_CLASSES` variable. The
  2535. OpenEmbedded build system uses the first package type (e.g. DEB, RPM,
  2536. or IPK) that appears with the variable
  2537. .. note::
  2538. Files using the ``.tar`` format are never used as a substitute
  2539. packaging format for DEB, RPM, and IPK formatted files for your image
  2540. or SDK.
  2541. :term:`IMAGE_POSTPROCESS_COMMAND`
  2542. Specifies a list of functions to call once the OpenEmbedded build
  2543. system creates the final image output files. You can specify
  2544. functions separated by semicolons:
  2545. ::
  2546. IMAGE_POSTPROCESS_COMMAND += "function; ... "
  2547. If you need to pass the root filesystem path to a command within the
  2548. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  2549. directory that becomes the root filesystem image. See the
  2550. :term:`IMAGE_ROOTFS` variable for more
  2551. information.
  2552. :term:`IMAGE_PREPROCESS_COMMAND`
  2553. Specifies a list of functions to call before the OpenEmbedded build
  2554. system creates the final image output files. You can specify
  2555. functions separated by semicolons:
  2556. ::
  2557. IMAGE_PREPROCESS_COMMAND += "function; ... "
  2558. If you need to pass the root filesystem path to a command within the
  2559. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  2560. directory that becomes the root filesystem image. See the
  2561. :term:`IMAGE_ROOTFS` variable for more
  2562. information.
  2563. :term:`IMAGE_ROOTFS`
  2564. The location of the root filesystem while it is under construction
  2565. (i.e. during the :ref:`ref-tasks-rootfs` task). This
  2566. variable is not configurable. Do not change it.
  2567. :term:`IMAGE_ROOTFS_ALIGNMENT`
  2568. Specifies the alignment for the output image file in Kbytes. If the
  2569. size of the image is not a multiple of this value, then the size is
  2570. rounded up to the nearest multiple of the value. The default value is
  2571. "1". See :term:`IMAGE_ROOTFS_SIZE` for
  2572. additional information.
  2573. :term:`IMAGE_ROOTFS_EXTRA_SPACE`
  2574. Defines additional free disk space created in the image in Kbytes. By
  2575. default, this variable is set to "0". This free disk space is added
  2576. to the image after the build system determines the image size as
  2577. described in ``IMAGE_ROOTFS_SIZE``.
  2578. This variable is particularly useful when you want to ensure that a
  2579. specific amount of free disk space is available on a device after an
  2580. image is installed and running. For example, to be sure 5 Gbytes of
  2581. free disk space is available, set the variable as follows:
  2582. ::
  2583. IMAGE_ROOTFS_EXTRA_SPACE = "5242880"
  2584. For example, the Yocto Project Build Appliance specifically requests
  2585. 40 Gbytes of extra space with the line:
  2586. ::
  2587. IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
  2588. :term:`IMAGE_ROOTFS_SIZE`
  2589. Defines the size in Kbytes for the generated image. The OpenEmbedded
  2590. build system determines the final size for the generated image using
  2591. an algorithm that takes into account the initial disk space used for
  2592. the generated image, a requested size for the image, and requested
  2593. additional free disk space to be added to the image. Programatically,
  2594. the build system determines the final size of the generated image as
  2595. follows:
  2596. ::
  2597. if (image-du * overhead) < rootfs-size:
  2598. internal-rootfs-size = rootfs-size + xspace
  2599. else:
  2600. internal-rootfs-size = (image-du * overhead) + xspace
  2601. where:
  2602. image-du = Returned value of the du command on the image.
  2603. overhead = IMAGE_OVERHEAD_FACTOR
  2604. rootfs-size = IMAGE_ROOTFS_SIZE
  2605. internal-rootfs-size = Initial root filesystem size before any modifications.
  2606. xspace = IMAGE_ROOTFS_EXTRA_SPACE
  2607. See the :term:`IMAGE_OVERHEAD_FACTOR`
  2608. and :term:`IMAGE_ROOTFS_EXTRA_SPACE`
  2609. variables for related information.
  2610. :term:`IMAGE_TYPEDEP`
  2611. Specifies a dependency from one image type on another. Here is an
  2612. example from the :ref:`image-live <ref-classes-image-live>` class:
  2613. ::
  2614. IMAGE_TYPEDEP_live = "ext3"
  2615. In the previous example, the variable ensures that when "live" is
  2616. listed with the :term:`IMAGE_FSTYPES` variable,
  2617. the OpenEmbedded build system produces an ``ext3`` image first since
  2618. one of the components of the live image is an ``ext3`` formatted
  2619. partition containing the root filesystem.
  2620. :term:`IMAGE_TYPES`
  2621. Specifies the complete list of supported image types by default:
  2622. - btrfs
  2623. - container
  2624. - cpio
  2625. - cpio.gz
  2626. - cpio.lz4
  2627. - cpio.lzma
  2628. - cpio.xz
  2629. - cramfs
  2630. - ext2
  2631. - ext2.bz2
  2632. - ext2.gz
  2633. - ext2.lzma
  2634. - ext3
  2635. - ext3.gz
  2636. - ext4
  2637. - ext4.gz
  2638. - f2fs
  2639. - hddimg
  2640. - iso
  2641. - jffs2
  2642. - jffs2.sum
  2643. - multiubi
  2644. - squashfs
  2645. - squashfs-lz4
  2646. - squashfs-lzo
  2647. - squashfs-xz
  2648. - tar
  2649. - tar.bz2
  2650. - tar.gz
  2651. - tar.lz4
  2652. - tar.xz
  2653. - tar.zst
  2654. - ubi
  2655. - ubifs
  2656. - wic
  2657. - wic.bz2
  2658. - wic.gz
  2659. - wic.lzma
  2660. For more information about these types of images, see
  2661. ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
  2662. :term:`IMAGE_VERSION_SUFFIX`
  2663. Version suffix that is part of the default :term:`IMAGE_NAME` and
  2664. :term:`KERNEL_ARTIFACT_NAME` values.
  2665. Defaults to ``"-${DATETIME}"``, however you could set this to a
  2666. version string that comes from your external build environment if
  2667. desired, and this suffix would then be used consistently across
  2668. the build artifacts.
  2669. :term:`INC_PR`
  2670. Helps define the recipe revision for recipes that share a common
  2671. ``include`` file. You can think of this variable as part of the
  2672. recipe revision as set from within an include file.
  2673. Suppose, for example, you have a set of recipes that are used across
  2674. several projects. And, within each of those recipes the revision (its
  2675. :term:`PR` value) is set accordingly. In this case, when
  2676. the revision of those recipes changes, the burden is on you to find
  2677. all those recipes and be sure that they get changed to reflect the
  2678. updated version of the recipe. In this scenario, it can get
  2679. complicated when recipes that are used in many places and provide
  2680. common functionality are upgraded to a new revision.
  2681. A more efficient way of dealing with this situation is to set the
  2682. ``INC_PR`` variable inside the ``include`` files that the recipes
  2683. share and then expand the ``INC_PR`` variable within the recipes to
  2684. help define the recipe revision.
  2685. The following provides an example that shows how to use the
  2686. ``INC_PR`` variable given a common ``include`` file that defines the
  2687. variable. Once the variable is defined in the ``include`` file, you
  2688. can use the variable to set the ``PR`` values in each recipe. You
  2689. will notice that when you set a recipe's ``PR`` you can provide more
  2690. granular revisioning by appending values to the ``INC_PR`` variable:
  2691. ::
  2692. recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
  2693. recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1"
  2694. recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0"
  2695. recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
  2696. The
  2697. first line of the example establishes the baseline revision to be
  2698. used for all recipes that use the ``include`` file. The remaining
  2699. lines in the example are from individual recipes and show how the
  2700. ``PR`` value is set.
  2701. :term:`INCOMPATIBLE_LICENSE`
  2702. Specifies a space-separated list of license names (as they would
  2703. appear in :term:`LICENSE`) that should be excluded
  2704. from the build. Recipes that provide no alternatives to listed
  2705. incompatible licenses are not built. Packages that are individually
  2706. licensed with the specified incompatible licenses will be deleted.
  2707. .. note::
  2708. This functionality is only regularly tested using the following
  2709. setting:
  2710. ::
  2711. INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0"
  2712. Although you can use other settings, you might be required to
  2713. remove dependencies on or provide alternatives to components that
  2714. are required to produce a functional system image.
  2715. .. note::
  2716. It is possible to define a list of licenses that are allowed to be
  2717. used instead of the licenses that are excluded. To do this, define
  2718. a variable ``COMPATIBLE_LICENSES`` with the names of the licences
  2719. that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as:
  2720. ::
  2721. INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}"
  2722. This will result in ``INCOMPATIBLE_LICENSE`` containing the names of
  2723. all licences from :term:`AVAILABLE_LICENSES` except the ones specified
  2724. in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to
  2725. be used.
  2726. :term:`INHERIT`
  2727. Causes the named class or classes to be inherited globally. Anonymous
  2728. functions in the class or classes are not executed for the base
  2729. configuration and in each individual recipe. The OpenEmbedded build
  2730. system ignores changes to ``INHERIT`` in individual recipes.
  2731. For more information on ``INHERIT``, see the
  2732. :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
  2733. section in the Bitbake User Manual.
  2734. :term:`INHERIT_DISTRO`
  2735. Lists classes that will be inherited at the distribution level. It is
  2736. unlikely that you want to edit this variable.
  2737. The default value of the variable is set as follows in the
  2738. ``meta/conf/distro/defaultsetup.conf`` file:
  2739. ::
  2740. INHERIT_DISTRO ?= "debian devshell sstate license"
  2741. :term:`INHIBIT_DEFAULT_DEPS`
  2742. Prevents the default dependencies, namely the C compiler and standard
  2743. C library (libc), from being added to :term:`DEPENDS`.
  2744. This variable is usually used within recipes that do not require any
  2745. compilation using the C compiler.
  2746. Set the variable to "1" to prevent the default dependencies from
  2747. being added.
  2748. :term:`INHIBIT_PACKAGE_DEBUG_SPLIT`
  2749. Prevents the OpenEmbedded build system from splitting out debug
  2750. information during packaging. By default, the build system splits out
  2751. debugging information during the
  2752. :ref:`ref-tasks-package` task. For more information on
  2753. how debug information is split out, see the
  2754. :term:`PACKAGE_DEBUG_SPLIT_STYLE`
  2755. variable.
  2756. To prevent the build system from splitting out debug information
  2757. during packaging, set the ``INHIBIT_PACKAGE_DEBUG_SPLIT`` variable as
  2758. follows:
  2759. ::
  2760. INHIBIT_PACKAGE_DEBUG_SPLIT = "1"
  2761. :term:`INHIBIT_PACKAGE_STRIP`
  2762. If set to "1", causes the build to not strip binaries in resulting
  2763. packages and prevents the ``-dbg`` package from containing the source
  2764. files.
  2765. By default, the OpenEmbedded build system strips binaries and puts
  2766. the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``.
  2767. Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you
  2768. plan to debug in general.
  2769. :term:`INHIBIT_SYSROOT_STRIP`
  2770. If set to "1", causes the build to not strip binaries in the
  2771. resulting sysroot.
  2772. By default, the OpenEmbedded build system strips binaries in the
  2773. resulting sysroot. When you specifically set the
  2774. ``INHIBIT_SYSROOT_STRIP`` variable to "1" in your recipe, you inhibit
  2775. this stripping.
  2776. If you want to use this variable, include the
  2777. :ref:`staging <ref-classes-staging>` class. This class uses a
  2778. ``sys_strip()`` function to test for the variable and acts
  2779. accordingly.
  2780. .. note::
  2781. Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and
  2782. special circumstances. For example, suppose you are building
  2783. bare-metal firmware by using an external GCC toolchain. Furthermore,
  2784. even if the toolchain's binaries are strippable, other files exist
  2785. that are needed for the build that are not strippable.
  2786. :term:`INITRAMFS_FSTYPES`
  2787. Defines the format for the output image of an initial RAM filesystem
  2788. (initramfs), which is used during boot. Supported formats are the
  2789. same as those supported by the
  2790. :term:`IMAGE_FSTYPES` variable.
  2791. The default value of this variable, which is set in the
  2792. ``meta/conf/bitbake.conf`` configuration file in the
  2793. :term:`Source Directory`, is "cpio.gz". The Linux kernel's
  2794. initramfs mechanism, as opposed to the initial RAM filesystem
  2795. `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects
  2796. an optionally compressed cpio archive.
  2797. :term:`INITRAMFS_IMAGE`
  2798. Specifies the :term:`PROVIDES` name of an image
  2799. recipe that is used to build an initial RAM filesystem (initramfs)
  2800. image. In other words, the ``INITRAMFS_IMAGE`` variable causes an
  2801. additional recipe to be built as a dependency to whatever root
  2802. filesystem recipe you might be using (e.g. ``core-image-sato``). The
  2803. initramfs image recipe you provide should set
  2804. :term:`IMAGE_FSTYPES` to
  2805. :term:`INITRAMFS_FSTYPES`.
  2806. An initramfs image provides a temporary root filesystem used for
  2807. early system initialization (e.g. loading of modules needed to locate
  2808. and mount the "real" root filesystem).
  2809. .. note::
  2810. See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb``
  2811. recipe in the :term:`Source Directory`
  2812. for an example initramfs recipe. To select this sample recipe as
  2813. the one built to provide the initramfs image, set ``INITRAMFS_IMAGE``
  2814. to "core-image-minimal-initramfs".
  2815. You can also find more information by referencing the
  2816. ``meta-poky/conf/local.conf.sample.extended`` configuration file in
  2817. the Source Directory, the :ref:`image <ref-classes-image>` class,
  2818. and the :ref:`kernel <ref-classes-kernel>` class to see how to use
  2819. the ``INITRAMFS_IMAGE`` variable.
  2820. If ``INITRAMFS_IMAGE`` is empty, which is the default, then no
  2821. initramfs image is built.
  2822. For more information, you can also see the
  2823. :term:`INITRAMFS_IMAGE_BUNDLE`
  2824. variable, which allows the generated image to be bundled inside the
  2825. kernel image. Additionally, for information on creating an initramfs
  2826. image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
  2827. in the Yocto Project Development Tasks Manual.
  2828. :term:`INITRAMFS_IMAGE_BUNDLE`
  2829. Controls whether or not the image recipe specified by
  2830. :term:`INITRAMFS_IMAGE` is run through an
  2831. extra pass
  2832. (:ref:`ref-tasks-bundle_initramfs`) during
  2833. kernel compilation in order to build a single binary that contains
  2834. both the kernel image and the initial RAM filesystem (initramfs)
  2835. image. This makes use of the
  2836. :term:`CONFIG_INITRAMFS_SOURCE` kernel
  2837. feature.
  2838. .. note::
  2839. Using an extra compilation pass to bundle the initramfs avoids a
  2840. circular dependency between the kernel recipe and the initramfs
  2841. recipe should the initramfs include kernel modules. Should that be
  2842. the case, the initramfs recipe depends on the kernel for the
  2843. kernel modules, and the kernel depends on the initramfs recipe
  2844. since the initramfs is bundled inside the kernel image.
  2845. The combined binary is deposited into the ``tmp/deploy`` directory,
  2846. which is part of the :term:`Build Directory`.
  2847. Setting the variable to "1" in a configuration file causes the
  2848. OpenEmbedded build system to generate a kernel image with the
  2849. initramfs specified in ``INITRAMFS_IMAGE`` bundled within:
  2850. ::
  2851. INITRAMFS_IMAGE_BUNDLE = "1"
  2852. By default, the
  2853. :ref:`kernel <ref-classes-kernel>` class sets this variable to a
  2854. null string as follows:
  2855. ::
  2856. INITRAMFS_IMAGE_BUNDLE ?= ""
  2857. .. note::
  2858. You must set the ``INITRAMFS_IMAGE_BUNDLE`` variable in a
  2859. configuration file. You cannot set the variable in a recipe file.
  2860. See the
  2861. :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>`
  2862. file for additional information. Also, for information on creating an
  2863. initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
  2864. in the Yocto Project Development Tasks Manual.
  2865. :term:`INITRAMFS_LINK_NAME`
  2866. The link name of the initial RAM filesystem image. This variable is
  2867. set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
  2868. follows:
  2869. ::
  2870. INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}"
  2871. The value of the
  2872. ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
  2873. file, has the following value:
  2874. ::
  2875. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  2876. See the :term:`MACHINE` variable for additional
  2877. information.
  2878. :term:`INITRAMFS_NAME`
  2879. The base name of the initial RAM filesystem image. This variable is
  2880. set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
  2881. follows:
  2882. ::
  2883. INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}"
  2884. The value of the :term:`KERNEL_ARTIFACT_NAME`
  2885. variable, which is set in the same file, has the following value:
  2886. ::
  2887. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  2888. :term:`INITRD`
  2889. Indicates list of filesystem images to concatenate and use as an
  2890. initial RAM disk (``initrd``).
  2891. The ``INITRD`` variable is an optional variable used with the
  2892. :ref:`image-live <ref-classes-image-live>` class.
  2893. :term:`INITRD_IMAGE`
  2894. When building a "live" bootable image (i.e. when
  2895. :term:`IMAGE_FSTYPES` contains "live"),
  2896. ``INITRD_IMAGE`` specifies the image recipe that should be built to
  2897. provide the initial RAM disk image. The default value is
  2898. "core-image-minimal-initramfs".
  2899. See the :ref:`image-live <ref-classes-image-live>` class for more
  2900. information.
  2901. :term:`INITSCRIPT_NAME`
  2902. The filename of the initialization script as installed to
  2903. ``${sysconfdir}/init.d``.
  2904. This variable is used in recipes when using ``update-rc.d.bbclass``.
  2905. The variable is mandatory.
  2906. :term:`INITSCRIPT_PACKAGES`
  2907. A list of the packages that contain initscripts. If multiple packages
  2908. are specified, you need to append the package name to the other
  2909. ``INITSCRIPT_*`` as an override.
  2910. This variable is used in recipes when using ``update-rc.d.bbclass``.
  2911. The variable is optional and defaults to the :term:`PN`
  2912. variable.
  2913. :term:`INITSCRIPT_PARAMS`
  2914. Specifies the options to pass to ``update-rc.d``. Here is an example:
  2915. ::
  2916. INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ."
  2917. In this example, the script has a runlevel of 99, starts the script
  2918. in initlevels 2 and 5, and stops the script in levels 0, 1 and 6.
  2919. The variable's default value is "defaults", which is set in the
  2920. :ref:`update-rc.d <ref-classes-update-rc.d>` class.
  2921. The value in ``INITSCRIPT_PARAMS`` is passed through to the
  2922. ``update-rc.d`` command. For more information on valid parameters,
  2923. please see the ``update-rc.d`` manual page at
  2924. https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
  2925. :term:`INSANE_SKIP`
  2926. Specifies the QA checks to skip for a specific package within a
  2927. recipe. For example, to skip the check for symbolic link ``.so``
  2928. files in the main package of a recipe, add the following to the
  2929. recipe. The package name override must be used, which in this example
  2930. is ``${PN}``:
  2931. ::
  2932. INSANE_SKIP_${PN} += "dev-so"
  2933. See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a
  2934. list of the valid QA checks you can specify using this variable.
  2935. :term:`INSTALL_TIMEZONE_FILE`
  2936. By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file.
  2937. Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the
  2938. configuration level to disable this behavior.
  2939. :term:`IPK_FEED_URIS`
  2940. When the IPK backend is in use and package management is enabled on
  2941. the target, you can use this variable to set up ``opkg`` in the
  2942. target image to point to package feeds on a nominated server. Once
  2943. the feed is established, you can perform installations or upgrades
  2944. using the package manager at runtime.
  2945. :term:`KARCH`
  2946. Defines the kernel architecture used when assembling the
  2947. configuration. Architectures supported for this release are:
  2948. - powerpc
  2949. - i386
  2950. - x86_64
  2951. - arm
  2952. - qemu
  2953. - mips
  2954. You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`.
  2955. :term:`KBRANCH`
  2956. A regular expression used by the build process to explicitly identify
  2957. the kernel branch that is validated, patched, and configured during a
  2958. build. You must set this variable to ensure the exact kernel branch
  2959. you want is being used by the build process.
  2960. Values for this variable are set in the kernel's recipe file and the
  2961. kernel's append file. For example, if you are using the
  2962. ``linux-yocto_4.12`` kernel, the kernel recipe file is the
  2963. ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. ``KBRANCH``
  2964. is set as follows in that kernel recipe file:
  2965. ::
  2966. KBRANCH ?= "standard/base"
  2967. This variable is also used from the kernel's append file to identify
  2968. the kernel branch specific to a particular machine or target
  2969. hardware. Continuing with the previous kernel example, the kernel's
  2970. append file (i.e. ``linux-yocto_4.12.bbappend``) is located in the
  2971. BSP layer for a given machine. For example, the append file for the
  2972. Beaglebone, EdgeRouter, and generic versions of both 32 and 64-bit IA
  2973. machines (``meta-yocto-bsp``) is named
  2974. ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``.
  2975. Here are the related statements from that append file:
  2976. ::
  2977. KBRANCH_genericx86 = "standard/base"
  2978. KBRANCH_genericx86-64 = "standard/base"
  2979. KBRANCH_edgerouter = "standard/edgerouter"
  2980. KBRANCH_beaglebone = "standard/beaglebone"
  2981. The ``KBRANCH`` statements
  2982. identify the kernel branch to use when building for each supported
  2983. BSP.
  2984. :term:`KBUILD_DEFCONFIG`
  2985. When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>`
  2986. class, specifies an "in-tree" kernel configuration file for use
  2987. during a kernel build.
  2988. Typically, when using a ``defconfig`` to configure a kernel during a
  2989. build, you place the file in your layer in the same manner as you
  2990. would place patch files and configuration fragment files (i.e.
  2991. "out-of-tree"). However, if you want to use a ``defconfig`` file that
  2992. is part of the kernel tree (i.e. "in-tree"), you can use the
  2993. ``KBUILD_DEFCONFIG`` variable and append the
  2994. :term:`KMACHINE` variable to point to the
  2995. ``defconfig`` file.
  2996. To use the variable, set it in the append file for your kernel recipe
  2997. using the following form:
  2998. ::
  2999. KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file
  3000. Here is an example from a "raspberrypi2" ``KMACHINE`` build that uses
  3001. a ``defconfig`` file named "bcm2709_defconfig":
  3002. ::
  3003. KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig"
  3004. As an alternative, you can use the following within your append file:
  3005. ::
  3006. KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file
  3007. For more
  3008. information on how to use the ``KBUILD_DEFCONFIG`` variable, see the
  3009. ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`"
  3010. section in the Yocto Project Linux Kernel Development Manual.
  3011. :term:`KERNEL_ALT_IMAGETYPE`
  3012. Specifies an alternate kernel image type for creation in addition to
  3013. the kernel image type specified using the
  3014. :term:`KERNEL_IMAGETYPE` variable.
  3015. :term:`KERNEL_ARTIFACT_NAME`
  3016. Specifies the name of all of the build artifacts. You can change the
  3017. name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME``
  3018. variable.
  3019. The value of ``KERNEL_ARTIFACT_NAME``, which is set in the
  3020. ``meta/classes/kernel-artifact-names.bbclass`` file, has the
  3021. following default value:
  3022. ::
  3023. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  3024. See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE`
  3025. and :term:`IMAGE_VERSION_SUFFIX` variables for additional information.
  3026. :term:`KERNEL_CLASSES`
  3027. A list of classes defining kernel image types that the
  3028. :ref:`kernel <ref-classes-kernel>` class should inherit. You
  3029. typically append this variable to enable extended image types. An
  3030. example is the "kernel-fitimage", which enables fitImage support and
  3031. resides in ``meta/classes/kernel-fitimage.bbclass``. You can register
  3032. custom kernel image types with the ``kernel`` class using this
  3033. variable.
  3034. :term:`KERNEL_DEVICETREE`
  3035. Specifies the name of the generated Linux kernel device tree (i.e.
  3036. the ``.dtb``) file.
  3037. .. note::
  3038. Legacy support exists for specifying the full path to the device
  3039. tree. However, providing just the ``.dtb`` file is preferred.
  3040. In order to use this variable, the
  3041. :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
  3042. be inherited.
  3043. :term:`KERNEL_DTB_LINK_NAME`
  3044. The link name of the kernel device tree binary (DTB). This variable
  3045. is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
  3046. follows:
  3047. ::
  3048. KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3049. The
  3050. value of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in
  3051. the same file, has the following value:
  3052. ::
  3053. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3054. See the :term:`MACHINE` variable for additional
  3055. information.
  3056. :term:`KERNEL_DTB_NAME`
  3057. The base name of the kernel device tree binary (DTB). This variable
  3058. is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
  3059. follows:
  3060. ::
  3061. KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3062. The value of the :term:`KERNEL_ARTIFACT_NAME`
  3063. variable, which is set in the same file, has the following value:
  3064. ::
  3065. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  3066. :term:`KERNEL_DTC_FLAGS`
  3067. Specifies the ``dtc`` flags that are passed to the Linux kernel build
  3068. system when generating the device trees (via ``DTC_FLAGS`` environment
  3069. variable).
  3070. In order to use this variable, the
  3071. :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
  3072. be inherited.
  3073. :term:`KERNEL_EXTRA_ARGS`
  3074. Specifies additional ``make`` command-line arguments the OpenEmbedded
  3075. build system passes on when compiling the kernel.
  3076. :term:`KERNEL_FEATURES`
  3077. Includes additional kernel metadata. In the OpenEmbedded build
  3078. system, the default Board Support Packages (BSPs)
  3079. :term:`Metadata` is provided through the
  3080. :term:`KMACHINE` and :term:`KBRANCH`
  3081. variables. You can use the ``KERNEL_FEATURES`` variable from within
  3082. the kernel recipe or kernel append file to further add metadata for
  3083. all BSPs or specific BSPs.
  3084. The metadata you add through this variable includes config fragments
  3085. and features descriptions, which usually includes patches as well as
  3086. config fragments. You typically override the ``KERNEL_FEATURES``
  3087. variable for a specific machine. In this way, you can provide
  3088. validated, but optional, sets of kernel configurations and features.
  3089. For example, the following example from the ``linux-yocto-rt_4.12``
  3090. kernel recipe adds "netfilter" and "taskstats" features to all BSPs
  3091. as well as "virtio" configurations to all QEMU machines. The last two
  3092. statements add specific configurations to targeted machine types:
  3093. ::
  3094. KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc"
  3095. KERNEL_FEATURES_append = "${KERNEL_EXTRA_FEATURES}"
  3096. KERNEL_FEATURES_append_qemuall = "cfg/virtio.scc"
  3097. KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
  3098. KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc"
  3099. :term:`KERNEL_FIT_LINK_NAME`
  3100. The link name of the kernel flattened image tree (FIT) image. This
  3101. variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
  3102. file as follows:
  3103. ::
  3104. KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3105. The value of the
  3106. ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
  3107. file, has the following value:
  3108. ::
  3109. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3110. See the :term:`MACHINE` variable for additional
  3111. information.
  3112. :term:`KERNEL_FIT_NAME`
  3113. The base name of the kernel flattened image tree (FIT) image. This
  3114. variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
  3115. file as follows:
  3116. ::
  3117. KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3118. The value of the :term:`KERNEL_ARTIFACT_NAME`
  3119. variable, which is set in the same file, has the following value:
  3120. ::
  3121. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  3122. :term:`KERNEL_IMAGE_LINK_NAME`
  3123. The link name for the kernel image. This variable is set in the
  3124. ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
  3125. ::
  3126. KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3127. The value of
  3128. the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
  3129. file, has the following value:
  3130. ::
  3131. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3132. See the :term:`MACHINE` variable for additional
  3133. information.
  3134. :term:`KERNEL_IMAGE_MAXSIZE`
  3135. Specifies the maximum size of the kernel image file in kilobytes. If
  3136. ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is
  3137. checked against the set value during the
  3138. :ref:`ref-tasks-sizecheck` task. The task fails if
  3139. the kernel image file is larger than the setting.
  3140. ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a
  3141. limited amount of space in which the kernel image must be stored.
  3142. By default, this variable is not set, which means the size of the
  3143. kernel image is not checked.
  3144. :term:`KERNEL_IMAGE_NAME`
  3145. The base name of the kernel image. This variable is set in the
  3146. ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
  3147. ::
  3148. KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3149. The value of the
  3150. :term:`KERNEL_ARTIFACT_NAME` variable,
  3151. which is set in the same file, has the following value:
  3152. ::
  3153. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  3154. :term:`KERNEL_IMAGETYPE`
  3155. The type of kernel to build for a device, usually set by the machine
  3156. configuration files and defaults to "zImage". This variable is used
  3157. when building the kernel and is passed to ``make`` as the target to
  3158. build.
  3159. If you want to build an alternate kernel image type in addition to that
  3160. specified by ``KERNEL_IMAGETYPE``, use the :term:`KERNEL_ALT_IMAGETYPE`
  3161. variable.
  3162. :term:`KERNEL_MODULE_AUTOLOAD`
  3163. Lists kernel modules that need to be auto-loaded during boot.
  3164. .. note::
  3165. This variable replaces the deprecated :term:`module_autoload`
  3166. variable.
  3167. You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it
  3168. can be recognized by the kernel recipe or by an out-of-tree kernel
  3169. module recipe (e.g. a machine configuration file, a distribution
  3170. configuration file, an append file for the recipe, or the recipe
  3171. itself).
  3172. Specify it as follows:
  3173. ::
  3174. KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3"
  3175. Including ``KERNEL_MODULE_AUTOLOAD`` causes the OpenEmbedded build
  3176. system to populate the ``/etc/modules-load.d/modname.conf`` file with
  3177. the list of modules to be auto-loaded on boot. The modules appear
  3178. one-per-line in the file. Here is an example of the most common use
  3179. case:
  3180. ::
  3181. KERNEL_MODULE_AUTOLOAD += "module_name"
  3182. For information on how to populate the ``modname.conf`` file with
  3183. ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable.
  3184. :term:`KERNEL_MODULE_PROBECONF`
  3185. Provides a list of modules for which the OpenEmbedded build system
  3186. expects to find ``module_conf_``\ modname values that specify
  3187. configuration for each of the modules. For information on how to
  3188. provide those module configurations, see the
  3189. :term:`module_conf_* <module_conf>` variable.
  3190. :term:`KERNEL_PATH`
  3191. The location of the kernel sources. This variable is set to the value
  3192. of the :term:`STAGING_KERNEL_DIR` within
  3193. the :ref:`module <ref-classes-module>` class. For information on
  3194. how this variable is used, see the
  3195. ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
  3196. section in the Yocto Project Linux Kernel Development Manual.
  3197. To help maximize compatibility with out-of-tree drivers used to build
  3198. modules, the OpenEmbedded build system also recognizes and uses the
  3199. :term:`KERNEL_SRC` variable, which is identical to
  3200. the ``KERNEL_PATH`` variable. Both variables are common variables
  3201. used by external Makefiles to point to the kernel source directory.
  3202. :term:`KERNEL_SRC`
  3203. The location of the kernel sources. This variable is set to the value
  3204. of the :term:`STAGING_KERNEL_DIR` within
  3205. the :ref:`module <ref-classes-module>` class. For information on
  3206. how this variable is used, see the
  3207. ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
  3208. section in the Yocto Project Linux Kernel Development Manual.
  3209. To help maximize compatibility with out-of-tree drivers used to build
  3210. modules, the OpenEmbedded build system also recognizes and uses the
  3211. :term:`KERNEL_PATH` variable, which is identical
  3212. to the ``KERNEL_SRC`` variable. Both variables are common variables
  3213. used by external Makefiles to point to the kernel source directory.
  3214. :term:`KERNEL_VERSION`
  3215. Specifies the version of the kernel as extracted from ``version.h``
  3216. or ``utsrelease.h`` within the kernel sources. Effects of setting
  3217. this variable do not take affect until the kernel has been
  3218. configured. Consequently, attempting to refer to this variable in
  3219. contexts prior to configuration will not work.
  3220. :term:`KERNELDEPMODDEPEND`
  3221. Specifies whether the data referenced through
  3222. :term:`PKGDATA_DIR` is needed or not. The
  3223. ``KERNELDEPMODDEPEND`` does not control whether or not that data
  3224. exists, but simply whether or not it is used. If you do not need to
  3225. use the data, set the ``KERNELDEPMODDEPEND`` variable in your
  3226. ``initramfs`` recipe. Setting the variable there when the data is not
  3227. needed avoids a potential dependency loop.
  3228. :term:`KFEATURE_DESCRIPTION`
  3229. Provides a short description of a configuration fragment. You use
  3230. this variable in the ``.scc`` file that describes a configuration
  3231. fragment file. Here is the variable used in a file named ``smp.scc``
  3232. to describe SMP being enabled:
  3233. ::
  3234. define KFEATURE_DESCRIPTION "Enable SMP"
  3235. :term:`KMACHINE`
  3236. The machine as known by the kernel. Sometimes the machine name used
  3237. by the kernel does not match the machine name used by the
  3238. OpenEmbedded build system. For example, the machine name that the
  3239. OpenEmbedded build system understands as ``core2-32-intel-common``
  3240. goes by a different name in the Linux Yocto kernel. The kernel
  3241. understands that machine as ``intel-core2-32``. For cases like these,
  3242. the ``KMACHINE`` variable maps the kernel machine name to the
  3243. OpenEmbedded build system machine name.
  3244. These mappings between different names occur in the Yocto Linux
  3245. Kernel's ``meta`` branch. As an example take a look in the
  3246. ``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file:
  3247. ::
  3248. LINUX_VERSION_core2-32-intel-common = "3.19.0"
  3249. COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}"
  3250. SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974"
  3251. SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711"
  3252. KMACHINE_core2-32-intel-common = "intel-core2-32"
  3253. KBRANCH_core2-32-intel-common = "standard/base"
  3254. KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}"
  3255. The ``KMACHINE`` statement says
  3256. that the kernel understands the machine name as "intel-core2-32".
  3257. However, the OpenEmbedded build system understands the machine as
  3258. "core2-32-intel-common".
  3259. :term:`KTYPE`
  3260. Defines the kernel type to be used in assembling the configuration.
  3261. The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
  3262. kernel types. See the ":ref:`kernel-dev/advanced:kernel types`"
  3263. section in the
  3264. Yocto Project Linux Kernel Development Manual for more information on
  3265. kernel types.
  3266. You define the ``KTYPE`` variable in the
  3267. :ref:`kernel-dev/advanced:bsp descriptions`. The
  3268. value you use must match the value used for the
  3269. :term:`LINUX_KERNEL_TYPE` value used by the
  3270. kernel recipe.
  3271. :term:`LABELS`
  3272. Provides a list of targets for automatic configuration.
  3273. See the :ref:`grub-efi <ref-classes-grub-efi>` class for more
  3274. information on how this variable is used.
  3275. :term:`LAYERDEPENDS`
  3276. Lists the layers, separated by spaces, on which this recipe depends.
  3277. Optionally, you can specify a specific layer version for a dependency
  3278. by adding it to the end of the layer name. Here is an example:
  3279. ::
  3280. LAYERDEPENDS_mylayer = "anotherlayer (=3)"
  3281. In this previous example,
  3282. version 3 of "anotherlayer" is compared against
  3283. :term:`LAYERVERSION`\ ``_anotherlayer``.
  3284. An error is produced if any dependency is missing or the version
  3285. numbers (if specified) do not match exactly. This variable is used in
  3286. the ``conf/layer.conf`` file and must be suffixed with the name of
  3287. the specific layer (e.g. ``LAYERDEPENDS_mylayer``).
  3288. :term:`LAYERDIR`
  3289. When used inside the ``layer.conf`` configuration file, this variable
  3290. provides the path of the current layer. This variable is not
  3291. available outside of ``layer.conf`` and references are expanded
  3292. immediately when parsing of the file completes.
  3293. :term:`LAYERRECOMMENDS`
  3294. Lists the layers, separated by spaces, recommended for use with this
  3295. layer.
  3296. Optionally, you can specify a specific layer version for a
  3297. recommendation by adding the version to the end of the layer name.
  3298. Here is an example:
  3299. ::
  3300. LAYERRECOMMENDS_mylayer = "anotherlayer (=3)"
  3301. In this previous example, version 3 of "anotherlayer" is compared
  3302. against ``LAYERVERSION_anotherlayer``.
  3303. This variable is used in the ``conf/layer.conf`` file and must be
  3304. suffixed with the name of the specific layer (e.g.
  3305. ``LAYERRECOMMENDS_mylayer``).
  3306. :term:`LAYERSERIES_COMPAT`
  3307. Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which
  3308. a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable
  3309. allows the layer maintainer to indicate which combinations of the
  3310. layer and OE-Core can be expected to work. The variable gives the
  3311. system a way to detect when a layer has not been tested with new
  3312. releases of OE-Core (e.g. the layer is not maintained).
  3313. To specify the OE-Core versions for which a layer is compatible, use
  3314. this variable in your layer's ``conf/layer.conf`` configuration file.
  3315. For the list, use the Yocto Project
  3316. :yocto_wiki:`Release Name </Releases>` (e.g.
  3317. &DISTRO_NAME_NO_CAP;). To specify multiple OE-Core versions for the
  3318. layer, use a space-separated list:
  3319. ::
  3320. LAYERSERIES_COMPAT_layer_root_name = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;"
  3321. .. note::
  3322. Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project
  3323. Compatible version 2 standard.
  3324. The OpenEmbedded build system produces a warning if the variable
  3325. is not set for any given layer.
  3326. See the ":ref:`dev-manual/common-tasks:creating your own layer`"
  3327. section in the Yocto Project Development Tasks Manual.
  3328. :term:`LAYERVERSION`
  3329. Optionally specifies the version of a layer as a single number. You
  3330. can use this within :term:`LAYERDEPENDS` for
  3331. another layer in order to depend on a specific version of the layer.
  3332. This variable is used in the ``conf/layer.conf`` file and must be
  3333. suffixed with the name of the specific layer (e.g.
  3334. ``LAYERVERSION_mylayer``).
  3335. :term:`LD`
  3336. The minimal command and arguments used to run the linker.
  3337. :term:`LDFLAGS`
  3338. Specifies the flags to pass to the linker. This variable is exported
  3339. to an environment variable and thus made visible to the software
  3340. being built during the compilation step.
  3341. Default initialization for ``LDFLAGS`` varies depending on what is
  3342. being built:
  3343. - :term:`TARGET_LDFLAGS` when building for the
  3344. target
  3345. - :term:`BUILD_LDFLAGS` when building for the
  3346. build host (i.e. ``-native``)
  3347. - :term:`BUILDSDK_LDFLAGS` when building for
  3348. an SDK (i.e. ``nativesdk-``)
  3349. :term:`LEAD_SONAME`
  3350. Specifies the lead (or primary) compiled library file (i.e. ``.so``)
  3351. that the :ref:`debian <ref-classes-debian>` class applies its
  3352. naming policy to given a recipe that packages multiple libraries.
  3353. This variable works in conjunction with the ``debian`` class.
  3354. :term:`LIC_FILES_CHKSUM`
  3355. Checksums of the license text in the recipe source code.
  3356. This variable tracks changes in license text of the source code
  3357. files. If the license text is changed, it will trigger a build
  3358. failure, which gives the developer an opportunity to review any
  3359. license change.
  3360. This variable must be defined for all recipes (unless
  3361. :term:`LICENSE` is set to "CLOSED").
  3362. For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`"
  3363. section in the Yocto Project Development Tasks Manual.
  3364. :term:`LICENSE`
  3365. The list of source licenses for the recipe. Follow these rules:
  3366. - Do not use spaces within individual license names.
  3367. - Separate license names using \| (pipe) when there is a choice
  3368. between licenses.
  3369. - Separate license names using & (ampersand) when multiple licenses
  3370. exist that cover different parts of the source.
  3371. - You can use spaces between license names.
  3372. - For standard licenses, use the names of the files in
  3373. ``meta/files/common-licenses/`` or the
  3374. :term:`SPDXLICENSEMAP` flag names defined in
  3375. ``meta/conf/licenses.conf``.
  3376. Here are some examples:
  3377. ::
  3378. LICENSE = "LGPLv2.1 | GPLv3"
  3379. LICENSE = "MPL-1 & LGPLv2.1"
  3380. LICENSE = "GPLv2+"
  3381. The first example is from the
  3382. recipes for Qt, which the user may choose to distribute under either
  3383. the LGPL version 2.1 or GPL version 3. The second example is from
  3384. Cairo where two licenses cover different parts of the source code.
  3385. The final example is from ``sysstat``, which presents a single
  3386. license.
  3387. You can also specify licenses on a per-package basis to handle
  3388. situations where components of the output have different licenses.
  3389. For example, a piece of software whose code is licensed under GPLv2
  3390. but has accompanying documentation licensed under the GNU Free
  3391. Documentation License 1.2 could be specified as follows:
  3392. ::
  3393. LICENSE = "GFDL-1.2 & GPLv2"
  3394. LICENSE_${PN} = "GPLv2"
  3395. LICENSE_${PN}-doc = "GFDL-1.2"
  3396. :term:`LICENSE_CREATE_PACKAGE`
  3397. Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded
  3398. build system to create an extra package (i.e.
  3399. ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add
  3400. those packages to the
  3401. :term:`RRECOMMENDS`\ ``_${PN}``.
  3402. The ``${PN}-lic`` package installs a directory in
  3403. ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base
  3404. name, and installs files in that directory that contain license and
  3405. copyright information (i.e. copies of the appropriate license files
  3406. from ``meta/common-licenses`` that match the licenses specified in
  3407. the :term:`LICENSE` variable of the recipe metadata
  3408. and copies of files marked in
  3409. :term:`LIC_FILES_CHKSUM` as containing
  3410. license text).
  3411. For related information on providing license text, see the
  3412. :term:`COPY_LIC_DIRS` variable, the
  3413. :term:`COPY_LIC_MANIFEST` variable, and the
  3414. ":ref:`dev-manual/common-tasks:providing license text`"
  3415. section in the Yocto Project Development Tasks Manual.
  3416. :term:`LICENSE_FLAGS`
  3417. Specifies additional flags for a recipe you must whitelist through
  3418. :term:`LICENSE_FLAGS_WHITELIST` in
  3419. order to allow the recipe to be built. When providing multiple flags,
  3420. separate them with spaces.
  3421. This value is independent of :term:`LICENSE` and is
  3422. typically used to mark recipes that might require additional licenses
  3423. in order to be used in a commercial product. For more information,
  3424. see the
  3425. ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
  3426. section in the Yocto Project Development Tasks Manual.
  3427. :term:`LICENSE_FLAGS_WHITELIST`
  3428. Lists license flags that when specified in
  3429. :term:`LICENSE_FLAGS` within a recipe should not
  3430. prevent that recipe from being built. This practice is otherwise
  3431. known as "whitelisting" license flags. For more information, see the
  3432. ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
  3433. section in the Yocto Project Development Tasks Manual.
  3434. :term:`LICENSE_PATH`
  3435. Path to additional licenses used during the build. By default, the
  3436. OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the
  3437. directory that holds common license text used during the build. The
  3438. ``LICENSE_PATH`` variable allows you to extend that location to other
  3439. areas that have additional licenses:
  3440. ::
  3441. LICENSE_PATH += "path-to-additional-common-licenses"
  3442. :term:`LINUX_KERNEL_TYPE`
  3443. Defines the kernel type to be used in assembling the configuration.
  3444. The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
  3445. kernel types. See the ":ref:`kernel-dev/advanced:kernel types`"
  3446. section in the
  3447. Yocto Project Linux Kernel Development Manual for more information on
  3448. kernel types.
  3449. If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to
  3450. "standard". Together with :term:`KMACHINE`, the
  3451. ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by
  3452. the kernel tools to find the appropriate description within the
  3453. kernel :term:`Metadata` with which to build out the sources
  3454. and configuration.
  3455. :term:`LINUX_VERSION`
  3456. The Linux version from ``kernel.org`` on which the Linux kernel image
  3457. being built using the OpenEmbedded build system is based. You define
  3458. this variable in the kernel recipe. For example, the
  3459. ``linux-yocto-3.4.bb`` kernel recipe found in
  3460. ``meta/recipes-kernel/linux`` defines the variables as follows:
  3461. ::
  3462. LINUX_VERSION ?= "3.4.24"
  3463. The ``LINUX_VERSION`` variable is used to define :term:`PV`
  3464. for the recipe:
  3465. ::
  3466. PV = "${LINUX_VERSION}+git${SRCPV}"
  3467. :term:`LINUX_VERSION_EXTENSION`
  3468. A string extension compiled into the version string of the Linux
  3469. kernel built with the OpenEmbedded build system. You define this
  3470. variable in the kernel recipe. For example, the linux-yocto kernel
  3471. recipes all define the variable as follows:
  3472. ::
  3473. LINUX_VERSION_EXTENSION ?= "-yocto-${LINUX_KERNEL_TYPE}"
  3474. Defining this variable essentially sets the Linux kernel
  3475. configuration item ``CONFIG_LOCALVERSION``, which is visible through
  3476. the ``uname`` command. Here is an example that shows the extension
  3477. assuming it was set as previously shown:
  3478. ::
  3479. $ uname -r
  3480. 3.7.0-rc8-custom
  3481. :term:`LOG_DIR`
  3482. Specifies the directory to which the OpenEmbedded build system writes
  3483. overall log files. The default directory is ``${TMPDIR}/log``.
  3484. For the directory containing logs specific to each task, see the
  3485. :term:`T` variable.
  3486. :term:`MACHINE`
  3487. Specifies the target device for which the image is built. You define
  3488. ``MACHINE`` in the ``local.conf`` file found in the
  3489. :term:`Build Directory`. By default, ``MACHINE`` is set to
  3490. "qemux86", which is an x86-based architecture machine to be emulated
  3491. using QEMU:
  3492. ::
  3493. MACHINE ?= "qemux86"
  3494. The variable corresponds to a machine configuration file of the same
  3495. name, through which machine-specific configurations are set. Thus,
  3496. when ``MACHINE`` is set to "qemux86" there exists the corresponding
  3497. ``qemux86.conf`` machine configuration file, which can be found in
  3498. the :term:`Source Directory` in
  3499. ``meta/conf/machine``.
  3500. The list of machines supported by the Yocto Project as shipped
  3501. include the following:
  3502. ::
  3503. MACHINE ?= "qemuarm"
  3504. MACHINE ?= "qemuarm64"
  3505. MACHINE ?= "qemumips"
  3506. MACHINE ?= "qemumips64"
  3507. MACHINE ?= "qemuppc"
  3508. MACHINE ?= "qemux86"
  3509. MACHINE ?= "qemux86-64"
  3510. MACHINE ?= "genericx86"
  3511. MACHINE ?= "genericx86-64"
  3512. MACHINE ?= "beaglebone"
  3513. MACHINE ?= "edgerouter"
  3514. The last five are Yocto Project reference hardware
  3515. boards, which are provided in the ``meta-yocto-bsp`` layer.
  3516. .. note::
  3517. Adding additional Board Support Package (BSP) layers to your
  3518. configuration adds new possible settings for ``MACHINE``.
  3519. :term:`MACHINE_ARCH`
  3520. Specifies the name of the machine-specific architecture. This
  3521. variable is set automatically from :term:`MACHINE` or
  3522. :term:`TUNE_PKGARCH`. You should not hand-edit
  3523. the ``MACHINE_ARCH`` variable.
  3524. :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
  3525. A list of required machine-specific packages to install as part of
  3526. the image being built. The build process depends on these packages
  3527. being present. Furthermore, because this is a "machine-essential"
  3528. variable, the list of packages are essential for the machine to boot.
  3529. The impact of this variable affects images based on
  3530. ``packagegroup-core-boot``, including the ``core-image-minimal``
  3531. image.
  3532. This variable is similar to the
  3533. ``MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` variable with the exception
  3534. that the image being built has a build dependency on the variable's
  3535. list of packages. In other words, the image will not build if a file
  3536. in this list is not found.
  3537. As an example, suppose the machine for which you are building
  3538. requires ``example-init`` to be run during boot to initialize the
  3539. hardware. In this case, you would use the following in the machine's
  3540. ``.conf`` configuration file:
  3541. ::
  3542. MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init"
  3543. :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
  3544. A list of recommended machine-specific packages to install as part of
  3545. the image being built. The build process does not depend on these
  3546. packages being present. However, because this is a
  3547. "machine-essential" variable, the list of packages are essential for
  3548. the machine to boot. The impact of this variable affects images based
  3549. on ``packagegroup-core-boot``, including the ``core-image-minimal``
  3550. image.
  3551. This variable is similar to the ``MACHINE_ESSENTIAL_EXTRA_RDEPENDS``
  3552. variable with the exception that the image being built does not have
  3553. a build dependency on the variable's list of packages. In other
  3554. words, the image will still build if a package in this list is not
  3555. found. Typically, this variable is used to handle essential kernel
  3556. modules, whose functionality may be selected to be built into the
  3557. kernel rather than as a module, in which case a package will not be
  3558. produced.
  3559. Consider an example where you have a custom kernel where a specific
  3560. touchscreen driver is required for the machine to be usable. However,
  3561. the driver can be built as a module or into the kernel depending on
  3562. the kernel configuration. If the driver is built as a module, you
  3563. want it to be installed. But, when the driver is built into the
  3564. kernel, you still want the build to succeed. This variable sets up a
  3565. "recommends" relationship so that in the latter case, the build will
  3566. not fail due to the missing package. To accomplish this, assuming the
  3567. package for the module was called ``kernel-module-ab123``, you would
  3568. use the following in the machine's ``.conf`` configuration file:
  3569. ::
  3570. MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123"
  3571. .. note::
  3572. In this example, the ``kernel-module-ab123`` recipe needs to
  3573. explicitly set its :term:`PACKAGES` variable to ensure that BitBake
  3574. does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to
  3575. satisfy the dependency.
  3576. Some examples of these machine essentials are flash, screen,
  3577. keyboard, mouse, or touchscreen drivers (depending on the machine).
  3578. :term:`MACHINE_EXTRA_RDEPENDS`
  3579. A list of machine-specific packages to install as part of the image
  3580. being built that are not essential for the machine to boot. However,
  3581. the build process for more fully-featured images depends on the
  3582. packages being present.
  3583. This variable affects all images based on ``packagegroup-base``,
  3584. which does not include the ``core-image-minimal`` or
  3585. ``core-image-full-cmdline`` images.
  3586. The variable is similar to the ``MACHINE_EXTRA_RRECOMMENDS`` variable
  3587. with the exception that the image being built has a build dependency
  3588. on the variable's list of packages. In other words, the image will
  3589. not build if a file in this list is not found.
  3590. An example is a machine that has WiFi capability but is not essential
  3591. for the machine to boot the image. However, if you are building a
  3592. more fully-featured image, you want to enable the WiFi. The package
  3593. containing the firmware for the WiFi hardware is always expected to
  3594. exist, so it is acceptable for the build process to depend upon
  3595. finding the package. In this case, assuming the package for the
  3596. firmware was called ``wifidriver-firmware``, you would use the
  3597. following in the ``.conf`` file for the machine:
  3598. ::
  3599. MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware"
  3600. :term:`MACHINE_EXTRA_RRECOMMENDS`
  3601. A list of machine-specific packages to install as part of the image
  3602. being built that are not essential for booting the machine. The image
  3603. being built has no build dependency on this list of packages.
  3604. This variable affects only images based on ``packagegroup-base``,
  3605. which does not include the ``core-image-minimal`` or
  3606. ``core-image-full-cmdline`` images.
  3607. This variable is similar to the ``MACHINE_EXTRA_RDEPENDS`` variable
  3608. with the exception that the image being built does not have a build
  3609. dependency on the variable's list of packages. In other words, the
  3610. image will build if a file in this list is not found.
  3611. An example is a machine that has WiFi capability but is not essential
  3612. For the machine to boot the image. However, if you are building a
  3613. more fully-featured image, you want to enable WiFi. In this case, the
  3614. package containing the WiFi kernel module will not be produced if the
  3615. WiFi driver is built into the kernel, in which case you still want
  3616. the build to succeed instead of failing as a result of the package
  3617. not being found. To accomplish this, assuming the package for the
  3618. module was called ``kernel-module-examplewifi``, you would use the
  3619. following in the ``.conf`` file for the machine:
  3620. ::
  3621. MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi"
  3622. :term:`MACHINE_FEATURES`
  3623. Specifies the list of hardware features the
  3624. :term:`MACHINE` is capable of supporting. For related
  3625. information on enabling features, see the
  3626. :term:`DISTRO_FEATURES`,
  3627. :term:`COMBINED_FEATURES`, and
  3628. :term:`IMAGE_FEATURES` variables.
  3629. For a list of hardware features supported by the Yocto Project as
  3630. shipped, see the ":ref:`ref-features-machine`" section.
  3631. :term:`MACHINE_FEATURES_BACKFILL`
  3632. Features to be added to ``MACHINE_FEATURES`` if not also present in
  3633. ``MACHINE_FEATURES_BACKFILL_CONSIDERED``.
  3634. This variable is set in the ``meta/conf/bitbake.conf`` file. It is
  3635. not intended to be user-configurable. It is best to just reference
  3636. the variable to see which machine features are being backfilled for
  3637. all machine configurations. See the ":ref:`ref-features-backfill`"
  3638. section for more information.
  3639. :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
  3640. Features from ``MACHINE_FEATURES_BACKFILL`` that should not be
  3641. backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See
  3642. the ":ref:`ref-features-backfill`" section for more information.
  3643. :term:`MACHINEOVERRIDES`
  3644. A colon-separated list of overrides that apply to the current
  3645. machine. By default, this list includes the value of
  3646. :term:`MACHINE`.
  3647. You can extend ``MACHINEOVERRIDES`` to add extra overrides that
  3648. should apply to a machine. For example, all machines emulated in QEMU
  3649. (e.g. ``qemuarm``, ``qemux86``, and so forth) include a file named
  3650. ``meta/conf/machine/include/qemu.inc`` that prepends the following
  3651. override to ``MACHINEOVERRIDES``:
  3652. ::
  3653. MACHINEOVERRIDES =. "qemuall:"
  3654. This
  3655. override allows variables to be overridden for all machines emulated
  3656. in QEMU, like in the following example from the ``connman-conf``
  3657. recipe:
  3658. ::
  3659. SRC_URI_append_qemuall = " file://wired.config \
  3660. file://wired-setup \
  3661. "
  3662. The underlying mechanism behind
  3663. ``MACHINEOVERRIDES`` is simply that it is included in the default
  3664. value of :term:`OVERRIDES`.
  3665. :term:`MAINTAINER`
  3666. The email address of the distribution maintainer.
  3667. :term:`MIRRORS`
  3668. Specifies additional paths from which the OpenEmbedded build system
  3669. gets source code. When the build system searches for source code, it
  3670. first tries the local download directory. If that location fails, the
  3671. build system tries locations defined by
  3672. :term:`PREMIRRORS`, the upstream source, and then
  3673. locations specified by ``MIRRORS`` in that order.
  3674. Assuming your distribution (:term:`DISTRO`) is "poky",
  3675. the default value for ``MIRRORS`` is defined in the
  3676. ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository.
  3677. :term:`MLPREFIX`
  3678. Specifies a prefix has been added to :term:`PN` to create a
  3679. special version of a recipe or package (i.e. a Multilib version). The
  3680. variable is used in places where the prefix needs to be added to or
  3681. removed from a the name (e.g. the :term:`BPN` variable).
  3682. ``MLPREFIX`` gets set when a prefix has been added to ``PN``.
  3683. .. note::
  3684. The "ML" in ``MLPREFIX`` stands for "MultiLib". This representation is
  3685. historical and comes from a time when ``nativesdk`` was a suffix
  3686. rather than a prefix on the recipe name. When ``nativesdk`` was turned
  3687. into a prefix, it made sense to set ``MLPREFIX`` for it as well.
  3688. To help understand when ``MLPREFIX`` might be needed, consider when
  3689. :term:`BBCLASSEXTEND` is used to provide a
  3690. ``nativesdk`` version of a recipe in addition to the target version.
  3691. If that recipe declares build-time dependencies on tasks in other
  3692. recipes by using :term:`DEPENDS`, then a dependency on
  3693. "foo" will automatically get rewritten to a dependency on
  3694. "nativesdk-foo". However, dependencies like the following will not
  3695. get rewritten automatically:
  3696. ::
  3697. do_foo[depends] += "recipe:do_foo"
  3698. If you want such a dependency to also get transformed, you can do the
  3699. following:
  3700. ::
  3701. do_foo[depends] += "${MLPREFIX}recipe:do_foo"
  3702. module_autoload
  3703. This variable has been replaced by the ``KERNEL_MODULE_AUTOLOAD``
  3704. variable. You should replace all occurrences of ``module_autoload``
  3705. with additions to ``KERNEL_MODULE_AUTOLOAD``, for example:
  3706. ::
  3707. module_autoload_rfcomm = "rfcomm"
  3708. should now be replaced with:
  3709. ::
  3710. KERNEL_MODULE_AUTOLOAD += "rfcomm"
  3711. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information.
  3712. module_conf
  3713. Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_
  3714. syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
  3715. file.
  3716. You can use this variable anywhere that it can be recognized by the
  3717. kernel recipe or out-of-tree kernel module recipe (e.g. a machine
  3718. configuration file, a distribution configuration file, an append file
  3719. for the recipe, or the recipe itself). If you use this variable, you
  3720. must also be sure to list the module name in the
  3721. :term:`KERNEL_MODULE_AUTOLOAD`
  3722. variable.
  3723. Here is the general syntax:
  3724. ::
  3725. module_conf_module_name = "modprobe.d-syntax"
  3726. You must use the kernel module name override.
  3727. Run ``man modprobe.d`` in the shell to find out more information on
  3728. the exact syntax you want to provide with ``module_conf``.
  3729. Including ``module_conf`` causes the OpenEmbedded build system to
  3730. populate the ``/etc/modprobe.d/modname.conf`` file with
  3731. ``modprobe.d`` syntax lines. Here is an example that adds the options
  3732. ``arg1`` and ``arg2`` to a module named ``mymodule``:
  3733. ::
  3734. module_conf_mymodule = "options mymodule arg1=val1 arg2=val2"
  3735. For information on how to specify kernel modules to auto-load on
  3736. boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable.
  3737. :term:`MODULE_TARBALL_DEPLOY`
  3738. Controls creation of the ``modules-*.tgz`` file. Set this variable to
  3739. "0" to disable creation of this file, which contains all of the
  3740. kernel modules resulting from a kernel build.
  3741. :term:`MODULE_TARBALL_LINK_NAME`
  3742. The link name of the kernel module tarball. This variable is set in
  3743. the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
  3744. ::
  3745. MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
  3746. The value
  3747. of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the
  3748. same file, has the following value:
  3749. ::
  3750. KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
  3751. See the :term:`MACHINE` variable for additional information.
  3752. :term:`MODULE_TARBALL_NAME`
  3753. The base name of the kernel module tarball. This variable is set in
  3754. the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
  3755. ::
  3756. MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}"
  3757. The value of the :term:`KERNEL_ARTIFACT_NAME` variable,
  3758. which is set in the same file, has the following value:
  3759. ::
  3760. KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
  3761. :term:`MULTIMACH_TARGET_SYS`
  3762. Uniquely identifies the type of the target system for which packages
  3763. are being built. This variable allows output for different types of
  3764. target systems to be put into different subdirectories of the same
  3765. output directory.
  3766. The default value of this variable is:
  3767. ::
  3768. ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS}
  3769. Some classes (e.g.
  3770. :ref:`cross-canadian <ref-classes-cross-canadian>`) modify the
  3771. ``MULTIMACH_TARGET_SYS`` value.
  3772. See the :term:`STAMP` variable for an example. See the
  3773. :term:`STAGING_DIR_TARGET` variable for more information.
  3774. :term:`NATIVELSBSTRING`
  3775. A string identifying the host distribution. Strings consist of the
  3776. host distributor ID followed by the release, as reported by the
  3777. ``lsb_release`` tool or as read from ``/etc/lsb-release``. For
  3778. example, when running a build on Ubuntu 12.10, the value is
  3779. "Ubuntu-12.10". If this information is unable to be determined, the
  3780. value resolves to "Unknown".
  3781. This variable is used by default to isolate native shared state
  3782. packages for different distributions (e.g. to avoid problems with
  3783. ``glibc`` version incompatibilities). Additionally, the variable is
  3784. checked against
  3785. :term:`SANITY_TESTED_DISTROS` if that
  3786. variable is set.
  3787. :term:`NM`
  3788. The minimal command and arguments to run ``nm``.
  3789. :term:`NO_GENERIC_LICENSE`
  3790. Avoids QA errors when you use a non-common, non-CLOSED license in a
  3791. recipe. Packages exist, such as the linux-firmware package, with many
  3792. licenses that are not in any way common. Also, new licenses are added
  3793. occasionally to avoid introducing a lot of common license files,
  3794. which are only applicable to a specific package.
  3795. ``NO_GENERIC_LICENSE`` is used to allow copying a license that does
  3796. not exist in common licenses.
  3797. The following example shows how to add ``NO_GENERIC_LICENSE`` to a
  3798. recipe:
  3799. ::
  3800. NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source"
  3801. The following is an example that
  3802. uses the ``LICENSE.Abilis.txt`` file as the license from the fetched
  3803. source:
  3804. ::
  3805. NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt"
  3806. :term:`NO_RECOMMENDATIONS`
  3807. Prevents installation of all "recommended-only" packages.
  3808. Recommended-only packages are packages installed only through the
  3809. :term:`RRECOMMENDS` variable). Setting the
  3810. ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: ::
  3811. NO_RECOMMENDATIONS = "1"
  3812. You can set this variable globally in your ``local.conf`` file or you
  3813. can attach it to a specific image recipe by using the recipe name
  3814. override: ::
  3815. NO_RECOMMENDATIONS_pn-target_image = "1"
  3816. It is important to realize that if you choose to not install packages
  3817. using this variable and some other packages are dependent on them
  3818. (i.e. listed in a recipe's :term:`RDEPENDS`
  3819. variable), the OpenEmbedded build system ignores your request and
  3820. will install the packages to avoid dependency errors.
  3821. .. note::
  3822. Some recommended packages might be required for certain system
  3823. functionality, such as kernel modules. It is up to you to add
  3824. packages with the :term:`IMAGE_INSTALL` variable.
  3825. Support for this variable exists only when using the IPK and RPM
  3826. packaging backend. Support does not exist for DEB.
  3827. See the :term:`BAD_RECOMMENDATIONS` and
  3828. the :term:`PACKAGE_EXCLUDE` variables for
  3829. related information.
  3830. :term:`NOAUTOPACKAGEDEBUG`
  3831. Disables auto package from splitting ``.debug`` files. If a recipe
  3832. requires ``FILES_${PN}-dbg`` to be set manually, the
  3833. ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the
  3834. content of the debug package. For example:
  3835. ::
  3836. NOAUTOPACKAGEDEBUG = "1"
  3837. FILES_${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*"
  3838. FILES_${PN}-dbg = "/usr/src/debug/"
  3839. FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch"
  3840. :term:`OBJCOPY`
  3841. The minimal command and arguments to run ``objcopy``.
  3842. :term:`OBJDUMP`
  3843. The minimal command and arguments to run ``objdump``.
  3844. :term:`OE_BINCONFIG_EXTRA_MANGLE`
  3845. When inheriting the :ref:`binconfig <ref-classes-binconfig>` class,
  3846. this variable specifies additional arguments passed to the "sed"
  3847. command. The sed command alters any paths in configuration scripts
  3848. that have been set up during compilation. Inheriting this class
  3849. results in all paths in these scripts being changed to point into the
  3850. ``sysroots/`` directory so that all builds that use the script will
  3851. use the correct directories for the cross compiling layout.
  3852. See the ``meta/classes/binconfig.bbclass`` in the
  3853. :term:`Source Directory` for details on how this class
  3854. applies these additional sed command arguments. For general
  3855. information on the ``binconfig`` class, see the
  3856. ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
  3857. :term:`OE_IMPORTS`
  3858. An internal variable used to tell the OpenEmbedded build system what
  3859. Python modules to import for every Python function run by the system.
  3860. .. note::
  3861. Do not set this variable. It is for internal use only.
  3862. :term:`OE_INIT_ENV_SCRIPT`
  3863. The name of the build environment setup script for the purposes of
  3864. setting up the environment within the extensible SDK. The default
  3865. value is "oe-init-build-env".
  3866. If you use a custom script to set up your build environment, set the
  3867. ``OE_INIT_ENV_SCRIPT`` variable to its name.
  3868. :term:`OE_TERMINAL`
  3869. Controls how the OpenEmbedded build system spawns interactive
  3870. terminals on the host development system (e.g. using the BitBake
  3871. command with the ``-c devshell`` command-line option). For more
  3872. information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in
  3873. the Yocto Project Development Tasks Manual.
  3874. You can use the following values for the ``OE_TERMINAL`` variable:
  3875. - auto
  3876. - gnome
  3877. - xfce
  3878. - rxvt
  3879. - screen
  3880. - konsole
  3881. - none
  3882. :term:`OEROOT`
  3883. The directory from which the top-level build environment setup script
  3884. is sourced. The Yocto Project provides a top-level build environment
  3885. setup script: :ref:`structure-core-script`. When you run this
  3886. script, the ``OEROOT`` variable resolves to the directory that
  3887. contains the script.
  3888. For additional information on how this variable is used, see the
  3889. initialization script.
  3890. :term:`OLDEST_KERNEL`
  3891. Declares the oldest version of the Linux kernel that the produced
  3892. binaries must support. This variable is passed into the build of the
  3893. Embedded GNU C Library (``glibc``).
  3894. The default for this variable comes from the
  3895. ``meta/conf/bitbake.conf`` configuration file. You can override this
  3896. default by setting the variable in a custom distribution
  3897. configuration file.
  3898. :term:`OVERRIDES`
  3899. A colon-separated list of overrides that currently apply. Overrides
  3900. are a BitBake mechanism that allows variables to be selectively
  3901. overridden at the end of parsing. The set of overrides in
  3902. ``OVERRIDES`` represents the "state" during building, which includes
  3903. the current recipe being built, the machine for which it is being
  3904. built, and so forth.
  3905. As an example, if the string "an-override" appears as an element in
  3906. the colon-separated list in ``OVERRIDES``, then the following
  3907. assignment will override ``FOO`` with the value "overridden" at the
  3908. end of parsing:
  3909. ::
  3910. FOO_an-override = "overridden"
  3911. See the
  3912. ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`"
  3913. section in the BitBake User Manual for more information on the
  3914. overrides mechanism.
  3915. The default value of ``OVERRIDES`` includes the values of the
  3916. :term:`CLASSOVERRIDE`,
  3917. :term:`MACHINEOVERRIDES`, and
  3918. :term:`DISTROOVERRIDES` variables. Another
  3919. important override included by default is ``pn-${PN}``. This override
  3920. allows variables to be set for a single recipe within configuration
  3921. (``.conf``) files. Here is an example:
  3922. ::
  3923. FOO_pn-myrecipe = "myrecipe-specific value"
  3924. .. note::
  3925. An easy way to see what overrides apply is to search for ``OVERRIDES``
  3926. in the output of the ``bitbake -e`` command. See the
  3927. ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto
  3928. Project Development Tasks Manual for more information.
  3929. :term:`P`
  3930. The recipe name and version. ``P`` is comprised of the following:
  3931. ::
  3932. ${PN}-${PV}
  3933. :term:`PACKAGE_ADD_METADATA`
  3934. This variable defines additional metdata to add to packages.
  3935. You may find you need to inject additional metadata into packages.
  3936. This variable allows you to do that by setting the injected data as
  3937. the value. Multiple fields can be added by splitting the content with
  3938. the literal separator "\n".
  3939. The suffixes '_IPK', '_DEB', or '_RPM' can be applied to the variable
  3940. to do package type specific settings. It can also be made package
  3941. specific by using the package name as a suffix.
  3942. You can find out more about applying this variable in the
  3943. ":ref:`dev-manual/common-tasks:adding custom metadata to packages`"
  3944. section in the Yocto Project Development Tasks Manual.
  3945. :term:`PACKAGE_ARCH`
  3946. The architecture of the resulting package or packages.
  3947. By default, the value of this variable is set to
  3948. :term:`TUNE_PKGARCH` when building for the
  3949. target, :term:`BUILD_ARCH` when building for the
  3950. build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the
  3951. SDK.
  3952. .. note::
  3953. See :term:`SDK_ARCH` for more information.
  3954. However, if your recipe's output packages are built specific to the
  3955. target machine rather than generally for the architecture of the
  3956. machine, you should set ``PACKAGE_ARCH`` to the value of
  3957. :term:`MACHINE_ARCH` in the recipe as follows:
  3958. ::
  3959. PACKAGE_ARCH = "${MACHINE_ARCH}"
  3960. :term:`PACKAGE_ARCHS`
  3961. Specifies a list of architectures compatible with the target machine.
  3962. This variable is set automatically and should not normally be
  3963. hand-edited. Entries are separated using spaces and listed in order
  3964. of priority. The default value for ``PACKAGE_ARCHS`` is "all any
  3965. noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}".
  3966. :term:`PACKAGE_BEFORE_PN`
  3967. Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so
  3968. that those added packages can pick up files that would normally be
  3969. included in the default package.
  3970. :term:`PACKAGE_CLASSES`
  3971. This variable, which is set in the ``local.conf`` configuration file
  3972. found in the ``conf`` folder of the
  3973. :term:`Build Directory`, specifies the package manager the
  3974. OpenEmbedded build system uses when packaging data.
  3975. You can provide one or more of the following arguments for the
  3976. variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk
  3977. package_tar"
  3978. .. note::
  3979. While it is a legal option, the ``package_tar``
  3980. class has limited functionality due to no support for package
  3981. dependencies by that backend. Therefore, it is recommended that
  3982. you do not use it.
  3983. The build system uses only the first argument in the list as the
  3984. package manager when creating your image or SDK. However, packages
  3985. will be created using any additional packaging classes you specify.
  3986. For example, if you use the following in your ``local.conf`` file:
  3987. ::
  3988. PACKAGE_CLASSES ?= "package_ipk"
  3989. The OpenEmbedded build system uses
  3990. the IPK package manager to create your image or SDK.
  3991. For information on packaging and build performance effects as a
  3992. result of the package manager in use, see the
  3993. ":ref:`package.bbclass <ref-classes-package>`" section.
  3994. :term:`PACKAGE_DEBUG_SPLIT_STYLE`
  3995. Determines how to split up the binary and debug information when
  3996. creating ``*-dbg`` packages to be used with the GNU Project Debugger
  3997. (GDB).
  3998. With the ``PACKAGE_DEBUG_SPLIT_STYLE`` variable, you can control
  3999. where debug information, which can include or exclude source files,
  4000. is stored:
  4001. - ".debug": Debug symbol files are placed next to the binary in a
  4002. ``.debug`` directory on the target. For example, if a binary is
  4003. installed into ``/bin``, the corresponding debug symbol files are
  4004. installed in ``/bin/.debug``. Source files are placed in
  4005. ``/usr/src/debug``.
  4006. - "debug-file-directory": Debug symbol files are placed under
  4007. ``/usr/lib/debug`` on the target, and separated by the path from
  4008. where the binary is installed. For example, if a binary is
  4009. installed in ``/bin``, the corresponding debug symbols are
  4010. installed in ``/usr/lib/debug/bin``. Source files are placed in
  4011. ``/usr/src/debug``.
  4012. - "debug-without-src": The same behavior as ".debug" previously
  4013. described with the exception that no source files are installed.
  4014. - "debug-with-srcpkg": The same behavior as ".debug" previously
  4015. described with the exception that all source files are placed in a
  4016. separate ``*-src`` pkg. This is the default behavior.
  4017. You can find out more about debugging using GDB by reading the
  4018. ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
  4019. in the Yocto Project Development Tasks Manual.
  4020. :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
  4021. Prevents specific packages from being installed when you are
  4022. installing complementary packages.
  4023. You might find that you want to prevent installing certain packages
  4024. when you are installing complementary packages. For example, if you
  4025. are using :term:`IMAGE_FEATURES` to install
  4026. ``dev-pkgs``, you might not want to install all packages from a
  4027. particular multilib. If you find yourself in this situation, you can
  4028. use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular
  4029. expressions to match the packages you want to exclude.
  4030. :term:`PACKAGE_EXCLUDE`
  4031. Lists packages that should not be installed into an image. For
  4032. example:
  4033. ::
  4034. PACKAGE_EXCLUDE = "package_name package_name package_name ..."
  4035. You can set this variable globally in your ``local.conf`` file or you
  4036. can attach it to a specific image recipe by using the recipe name
  4037. override:
  4038. ::
  4039. PACKAGE_EXCLUDE_pn-target_image = "package_name"
  4040. If you choose to not install a package using this variable and some
  4041. other package is dependent on it (i.e. listed in a recipe's
  4042. :term:`RDEPENDS` variable), the OpenEmbedded build
  4043. system generates a fatal installation error. Because the build system
  4044. halts the process with a fatal error, you can use the variable with
  4045. an iterative development process to remove specific components from a
  4046. system.
  4047. Support for this variable exists only when using the IPK and RPM
  4048. packaging backend. Support does not exist for DEB.
  4049. See the :term:`NO_RECOMMENDATIONS` and the
  4050. :term:`BAD_RECOMMENDATIONS` variables for
  4051. related information.
  4052. :term:`PACKAGE_EXTRA_ARCHS`
  4053. Specifies the list of architectures compatible with the device CPU.
  4054. This variable is useful when you build for several different devices
  4055. that use miscellaneous processors such as XScale and ARM926-EJS.
  4056. :term:`PACKAGE_FEED_ARCHS`
  4057. Optionally specifies the package architectures used as part of the
  4058. package feed URIs during the build. When used, the
  4059. ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed
  4060. URI, which is constructed using the
  4061. :term:`PACKAGE_FEED_URIS` and
  4062. :term:`PACKAGE_FEED_BASE_PATHS`
  4063. variables.
  4064. .. note::
  4065. You can use the ``PACKAGE_FEED_ARCHS``
  4066. variable to whitelist specific package architectures. If you do
  4067. not need to whitelist specific architectures, which is a common
  4068. case, you can omit this variable. Omitting the variable results in
  4069. all available architectures for the current machine being included
  4070. into remote package feeds.
  4071. Consider the following example where the ``PACKAGE_FEED_URIS``,
  4072. ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are
  4073. defined in your ``local.conf`` file:
  4074. ::
  4075. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  4076. https://example.com/packagerepos/updates"
  4077. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  4078. PACKAGE_FEED_ARCHS = "all core2-64"
  4079. Given these settings, the resulting package feeds are as follows:
  4080. .. code-block:: none
  4081. https://example.com/packagerepos/release/rpm/all
  4082. https://example.com/packagerepos/release/rpm/core2-64
  4083. https://example.com/packagerepos/release/rpm-dev/all
  4084. https://example.com/packagerepos/release/rpm-dev/core2-64
  4085. https://example.com/packagerepos/updates/rpm/all
  4086. https://example.com/packagerepos/updates/rpm/core2-64
  4087. https://example.com/packagerepos/updates/rpm-dev/all
  4088. https://example.com/packagerepos/updates/rpm-dev/core2-64
  4089. :term:`PACKAGE_FEED_BASE_PATHS`
  4090. Specifies the base path used when constructing package feed URIs. The
  4091. ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a
  4092. package feed URI used by the OpenEmbedded build system. The base path
  4093. lies between the :term:`PACKAGE_FEED_URIS`
  4094. and :term:`PACKAGE_FEED_ARCHS` variables.
  4095. Consider the following example where the ``PACKAGE_FEED_URIS``,
  4096. ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are
  4097. defined in your ``local.conf`` file:
  4098. ::
  4099. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  4100. https://example.com/packagerepos/updates"
  4101. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  4102. PACKAGE_FEED_ARCHS = "all core2-64"
  4103. Given these settings, the resulting package feeds are as follows:
  4104. .. code-block:: none
  4105. https://example.com/packagerepos/release/rpm/all
  4106. https://example.com/packagerepos/release/rpm/core2-64
  4107. https://example.com/packagerepos/release/rpm-dev/all
  4108. https://example.com/packagerepos/release/rpm-dev/core2-64
  4109. https://example.com/packagerepos/updates/rpm/all
  4110. https://example.com/packagerepos/updates/rpm/core2-64
  4111. https://example.com/packagerepos/updates/rpm-dev/all
  4112. https://example.com/packagerepos/updates/rpm-dev/core2-64
  4113. :term:`PACKAGE_FEED_URIS`
  4114. Specifies the front portion of the package feed URI used by the
  4115. OpenEmbedded build system. Each final package feed URI is comprised
  4116. of ``PACKAGE_FEED_URIS``,
  4117. :term:`PACKAGE_FEED_BASE_PATHS`, and
  4118. :term:`PACKAGE_FEED_ARCHS` variables.
  4119. Consider the following example where the ``PACKAGE_FEED_URIS``,
  4120. ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are
  4121. defined in your ``local.conf`` file:
  4122. ::
  4123. PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
  4124. https://example.com/packagerepos/updates"
  4125. PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
  4126. PACKAGE_FEED_ARCHS = "all core2-64"
  4127. Given these settings, the resulting package feeds are as follows:
  4128. .. code-block:: none
  4129. https://example.com/packagerepos/release/rpm/all
  4130. https://example.com/packagerepos/release/rpm/core2-64
  4131. https://example.com/packagerepos/release/rpm-dev/all
  4132. https://example.com/packagerepos/release/rpm-dev/core2-64
  4133. https://example.com/packagerepos/updates/rpm/all
  4134. https://example.com/packagerepos/updates/rpm/core2-64
  4135. https://example.com/packagerepos/updates/rpm-dev/all
  4136. https://example.com/packagerepos/updates/rpm-dev/core2-64
  4137. :term:`PACKAGE_INSTALL`
  4138. The final list of packages passed to the package manager for
  4139. installation into the image.
  4140. Because the package manager controls actual installation of all
  4141. packages, the list of packages passed using ``PACKAGE_INSTALL`` is
  4142. not the final list of packages that are actually installed. This
  4143. variable is internal to the image construction code. Consequently, in
  4144. general, you should use the
  4145. :term:`IMAGE_INSTALL` variable to specify
  4146. packages for installation. The exception to this is when working with
  4147. the :ref:`core-image-minimal-initramfs <ref-manual/images:images>`
  4148. image. When working with an initial RAM filesystem (initramfs) image,
  4149. use the ``PACKAGE_INSTALL`` variable. For information on creating an
  4150. initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
  4151. in the Yocto Project Development Tasks Manual.
  4152. :term:`PACKAGE_INSTALL_ATTEMPTONLY`
  4153. Specifies a list of packages the OpenEmbedded build system attempts
  4154. to install when creating an image. If a listed package fails to
  4155. install, the build system does not generate an error. This variable
  4156. is generally not user-defined.
  4157. :term:`PACKAGE_PREPROCESS_FUNCS`
  4158. Specifies a list of functions run to pre-process the
  4159. :term:`PKGD` directory prior to splitting the files out
  4160. to individual packages.
  4161. :term:`PACKAGE_WRITE_DEPS`
  4162. Specifies a list of dependencies for post-installation and
  4163. pre-installation scripts on native/cross tools. If your
  4164. post-installation or pre-installation script can execute at rootfs
  4165. creation time rather than on the target but depends on a native tool
  4166. in order to execute, you need to list the tools in
  4167. ``PACKAGE_WRITE_DEPS``.
  4168. For information on running post-installation scripts, see the
  4169. ":ref:`dev-manual/common-tasks:post-installation scripts`"
  4170. section in the Yocto Project Development Tasks Manual.
  4171. :term:`PACKAGECONFIG`
  4172. This variable provides a means of enabling or disabling features of a
  4173. recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in
  4174. recipes when you specify features and then arguments that define
  4175. feature behaviors. Here is the basic block structure (broken over
  4176. multiple lines for readability):
  4177. ::
  4178. PACKAGECONFIG ??= "f1 f2 f3 ..."
  4179. PACKAGECONFIG[f1] = "\
  4180. --with-f1, \
  4181. --without-f1, \
  4182. build-deps-for-f1, \
  4183. runtime-deps-for-f1, \
  4184. runtime-recommends-for-f1, \
  4185. packageconfig-conflicts-for-f1"
  4186. PACKAGECONFIG[f2] = "\
  4187. ... and so on and so on ...
  4188. The ``PACKAGECONFIG`` variable itself specifies a space-separated
  4189. list of the features to enable. Following the features, you can
  4190. determine the behavior of each feature by providing up to six
  4191. order-dependent arguments, which are separated by commas. You can
  4192. omit any argument you like but must retain the separating commas. The
  4193. order is important and specifies the following:
  4194. 1. Extra arguments that should be added to the configure script
  4195. argument list (:term:`EXTRA_OECONF` or
  4196. :term:`PACKAGECONFIG_CONFARGS`) if
  4197. the feature is enabled.
  4198. 2. Extra arguments that should be added to ``EXTRA_OECONF`` or
  4199. ``PACKAGECONFIG_CONFARGS`` if the feature is disabled.
  4200. 3. Additional build dependencies (:term:`DEPENDS`)
  4201. that should be added if the feature is enabled.
  4202. 4. Additional runtime dependencies (:term:`RDEPENDS`)
  4203. that should be added if the feature is enabled.
  4204. 5. Additional runtime recommendations
  4205. (:term:`RRECOMMENDS`) that should be added if
  4206. the feature is enabled.
  4207. 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG``
  4208. settings for this feature.
  4209. Consider the following ``PACKAGECONFIG`` block taken from the
  4210. ``librsvg`` recipe. In this example the feature is ``gtk``, which has
  4211. three arguments that determine the feature's behavior.
  4212. ::
  4213. PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3"
  4214. The
  4215. ``--with-gtk3`` and ``gtk+3`` arguments apply only if the feature is
  4216. enabled. In this case, ``--with-gtk3`` is added to the configure
  4217. script argument list and ``gtk+3`` is added to ``DEPENDS``. On the
  4218. other hand, if the feature is disabled say through a ``.bbappend``
  4219. file in another layer, then the second argument ``--without-gtk3`` is
  4220. added to the configure script instead.
  4221. The basic ``PACKAGECONFIG`` structure previously described holds true
  4222. regardless of whether you are creating a block or changing a block.
  4223. When creating a block, use the structure inside your recipe.
  4224. If you want to change an existing ``PACKAGECONFIG`` block, you can do
  4225. so one of two ways:
  4226. - *Append file:* Create an append file named
  4227. recipename\ ``.bbappend`` in your layer and override the value of
  4228. ``PACKAGECONFIG``. You can either completely override the
  4229. variable:
  4230. ::
  4231. PACKAGECONFIG = "f4 f5"
  4232. Or, you can just append the variable:
  4233. ::
  4234. PACKAGECONFIG_append = " f4"
  4235. - *Configuration file:* This method is identical to changing the
  4236. block through an append file except you edit your ``local.conf``
  4237. or ``mydistro.conf`` file. As with append files previously
  4238. described, you can either completely override the variable:
  4239. ::
  4240. PACKAGECONFIG_pn-recipename = "f4 f5"
  4241. Or, you can just amend the variable:
  4242. ::
  4243. PACKAGECONFIG_append_pn-recipename = " f4"
  4244. :term:`PACKAGECONFIG_CONFARGS`
  4245. A space-separated list of configuration options generated from the
  4246. :term:`PACKAGECONFIG` setting.
  4247. Classes such as :ref:`autotools <ref-classes-autotools>` and
  4248. :ref:`cmake <ref-classes-cmake>` use ``PACKAGECONFIG_CONFARGS`` to
  4249. pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``,
  4250. respectively. If you are using ``PACKAGECONFIG`` but not a class that
  4251. handles the ``do_configure`` task, then you need to use
  4252. ``PACKAGECONFIG_CONFARGS`` appropriately.
  4253. :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY`
  4254. For recipes inheriting the
  4255. :ref:`packagegroup <ref-classes-packagegroup>` class, setting
  4256. ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the
  4257. normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth)
  4258. should not be automatically created by the ``packagegroup`` recipe,
  4259. which is the default behavior.
  4260. :term:`PACKAGES`
  4261. The list of packages the recipe creates. The default value is the
  4262. following:
  4263. ::
  4264. ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
  4265. During packaging, the :ref:`ref-tasks-package` task
  4266. goes through ``PACKAGES`` and uses the :term:`FILES`
  4267. variable corresponding to each package to assign files to the
  4268. package. If a file matches the ``FILES`` variable for more than one
  4269. package in ``PACKAGES``, it will be assigned to the earliest
  4270. (leftmost) package.
  4271. Packages in the variable's list that are empty (i.e. where none of
  4272. the patterns in ``FILES_``\ pkg match any files installed by the
  4273. :ref:`ref-tasks-install` task) are not generated,
  4274. unless generation is forced through the
  4275. :term:`ALLOW_EMPTY` variable.
  4276. :term:`PACKAGES_DYNAMIC`
  4277. A promise that your recipe satisfies runtime dependencies for
  4278. optional modules that are found in other recipes.
  4279. ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it
  4280. only states that they should be satisfied. For example, if a hard,
  4281. runtime dependency (:term:`RDEPENDS`) of another
  4282. package is satisfied at build time through the ``PACKAGES_DYNAMIC``
  4283. variable, but a package with the module name is never actually
  4284. produced, then the other package will be broken. Thus, if you attempt
  4285. to include that package in an image, you will get a dependency
  4286. failure from the packaging system during the
  4287. :ref:`ref-tasks-rootfs` task.
  4288. Typically, if there is a chance that such a situation can occur and
  4289. the package that is not created is valid without the dependency being
  4290. satisfied, then you should use :term:`RRECOMMENDS`
  4291. (a soft runtime dependency) instead of ``RDEPENDS``.
  4292. For an example of how to use the ``PACKAGES_DYNAMIC`` variable when
  4293. you are splitting packages, see the
  4294. ":ref:`dev-manual/common-tasks:handling optional module packaging`"
  4295. section in the Yocto Project Development Tasks Manual.
  4296. :term:`PACKAGESPLITFUNCS`
  4297. Specifies a list of functions run to perform additional splitting of
  4298. files into individual packages. Recipes can either prepend to this
  4299. variable or prepend to the ``populate_packages`` function in order to
  4300. perform additional package splitting. In either case, the function
  4301. should set :term:`PACKAGES`,
  4302. :term:`FILES`, :term:`RDEPENDS` and
  4303. other packaging variables appropriately in order to perform the
  4304. desired splitting.
  4305. :term:`PARALLEL_MAKE`
  4306. Extra options passed to the ``make`` command during the
  4307. :ref:`ref-tasks-compile` task in order to specify
  4308. parallel compilation on the local build host. This variable is
  4309. usually in the form "-j x", where x represents the maximum number of
  4310. parallel threads ``make`` can run.
  4311. .. note::
  4312. In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be
  4313. called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure
  4314. this is to use the ``oe_runmake`` function.
  4315. By default, the OpenEmbedded build system automatically sets this
  4316. variable to be equal to the number of cores the build system uses.
  4317. .. note::
  4318. If the software being built experiences dependency issues during
  4319. the ``do_compile`` task that result in race conditions, you can clear
  4320. the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For
  4321. information on addressing race conditions, see the
  4322. ":ref:`dev-manual/common-tasks:debugging parallel make races`"
  4323. section in the Yocto Project Development Tasks Manual.
  4324. For single socket systems (i.e. one CPU), you should not have to
  4325. override this variable to gain optimal parallelism during builds.
  4326. However, if you have very large systems that employ multiple physical
  4327. CPUs, you might want to make sure the ``PARALLEL_MAKE`` variable is
  4328. not set higher than "-j 20".
  4329. For more information on speeding up builds, see the
  4330. ":ref:`dev-manual/common-tasks:speeding up a build`"
  4331. section in the Yocto Project Development Tasks Manual.
  4332. :term:`PARALLEL_MAKEINST`
  4333. Extra options passed to the ``make install`` command during the
  4334. :ref:`ref-tasks-install` task in order to specify
  4335. parallel installation. This variable defaults to the value of
  4336. :term:`PARALLEL_MAKE`.
  4337. .. note::
  4338. In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must
  4339. be called with
  4340. ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy
  4341. way to ensure this is to use the ``oe_runmake`` function.
  4342. If the software being built experiences dependency issues during
  4343. the ``do_install`` task that result in race conditions, you can
  4344. clear the ``PARALLEL_MAKEINST`` variable within the recipe as a
  4345. workaround. For information on addressing race conditions, see the
  4346. ":ref:`dev-manual/common-tasks:debugging parallel make races`"
  4347. section in the Yocto Project Development Tasks Manual.
  4348. :term:`PATCHRESOLVE`
  4349. Determines the action to take when a patch fails. You can set this
  4350. variable to one of two values: "noop" and "user".
  4351. The default value of "noop" causes the build to simply fail when the
  4352. OpenEmbedded build system cannot successfully apply a patch. Setting
  4353. the value to "user" causes the build system to launch a shell and
  4354. places you in the right location so that you can manually resolve the
  4355. conflicts.
  4356. Set this variable in your ``local.conf`` file.
  4357. :term:`PATCHTOOL`
  4358. Specifies the utility used to apply patches for a recipe during the
  4359. :ref:`ref-tasks-patch` task. You can specify one of
  4360. three utilities: "patch", "quilt", or "git". The default utility used
  4361. is "quilt" except for the quilt-native recipe itself. Because the
  4362. quilt tool is not available at the time quilt-native is being
  4363. patched, it uses "patch".
  4364. If you wish to use an alternative patching tool, set the variable in
  4365. the recipe using one of the following:
  4366. ::
  4367. PATCHTOOL = "patch"
  4368. PATCHTOOL = "quilt"
  4369. PATCHTOOL = "git"
  4370. :term:`PE`
  4371. The epoch of the recipe. By default, this variable is unset. The
  4372. variable is used to make upgrades possible when the versioning scheme
  4373. changes in some backwards incompatible way.
  4374. ``PE`` is the default value of the :term:`PKGE` variable.
  4375. :term:`PF`
  4376. Specifies the recipe or package name and includes all version and
  4377. revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and
  4378. ``bash-4.2-r1/``). This variable is comprised of the following:
  4379. ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`}
  4380. :term:`PIXBUF_PACKAGES`
  4381. When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>`
  4382. class, this variable identifies packages that contain the pixbuf
  4383. loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache``
  4384. class assumes that the loaders are in the recipe's main package (i.e.
  4385. ``${``\ :term:`PN`\ ``}``). Use this variable if the
  4386. loaders you need are in a package other than that main package.
  4387. :term:`PKG`
  4388. The name of the resulting package created by the OpenEmbedded build
  4389. system.
  4390. .. note::
  4391. When using the ``PKG`` variable, you must use a package name override.
  4392. For example, when the :ref:`debian <ref-classes-debian>` class
  4393. renames the output package, it does so by setting
  4394. ``PKG_packagename``.
  4395. :term:`PKG_CONFIG_PATH`
  4396. The path to ``pkg-config`` files for the current build context.
  4397. ``pkg-config`` reads this variable from the environment.
  4398. :term:`PKGD`
  4399. Points to the destination directory for files to be packaged before
  4400. they are split into individual packages. This directory defaults to
  4401. the following:
  4402. ::
  4403. ${WORKDIR}/package
  4404. Do not change this default.
  4405. :term:`PKGDATA_DIR`
  4406. Points to a shared, global-state directory that holds data generated
  4407. during the packaging process. During the packaging process, the
  4408. :ref:`ref-tasks-packagedata` task packages data
  4409. for each recipe and installs it into this temporary, shared area.
  4410. This directory defaults to the following, which you should not
  4411. change:
  4412. ::
  4413. ${STAGING_DIR_HOST}/pkgdata
  4414. For examples of how this data is used, see the
  4415. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  4416. section in the Yocto Project Overview and Concepts Manual and the
  4417. ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``"
  4418. section in the Yocto Project Development Tasks Manual. For more
  4419. information on the shared, global-state directory, see
  4420. :term:`STAGING_DIR_HOST`.
  4421. :term:`PKGDEST`
  4422. Points to the parent directory for files to be packaged after they
  4423. have been split into individual packages. This directory defaults to
  4424. the following:
  4425. ::
  4426. ${WORKDIR}/packages-split
  4427. Under this directory, the build system creates directories for each
  4428. package specified in :term:`PACKAGES`. Do not change
  4429. this default.
  4430. :term:`PKGDESTWORK`
  4431. Points to a temporary work area where the
  4432. :ref:`ref-tasks-package` task saves package metadata.
  4433. The ``PKGDESTWORK`` location defaults to the following:
  4434. ::
  4435. ${WORKDIR}/pkgdata
  4436. Do not change this default.
  4437. The :ref:`ref-tasks-packagedata` task copies the
  4438. package metadata from ``PKGDESTWORK`` to
  4439. :term:`PKGDATA_DIR` to make it available globally.
  4440. :term:`PKGE`
  4441. The epoch of the package(s) built by the recipe. By default, ``PKGE``
  4442. is set to :term:`PE`.
  4443. :term:`PKGR`
  4444. The revision of the package(s) built by the recipe. By default,
  4445. ``PKGR`` is set to :term:`PR`.
  4446. :term:`PKGV`
  4447. The version of the package(s) built by the recipe. By default,
  4448. ``PKGV`` is set to :term:`PV`.
  4449. :term:`PN`
  4450. This variable can have two separate functions depending on the
  4451. context: a recipe name or a resulting package name.
  4452. ``PN`` refers to a recipe name in the context of a file used by the
  4453. OpenEmbedded build system as input to create a package. The name is
  4454. normally extracted from the recipe file name. For example, if the
  4455. recipe is named ``expat_2.0.1.bb``, then the default value of ``PN``
  4456. will be "expat".
  4457. The variable refers to a package name in the context of a file
  4458. created or produced by the OpenEmbedded build system.
  4459. If applicable, the ``PN`` variable also contains any special suffix
  4460. or prefix. For example, using ``bash`` to build packages for the
  4461. native machine, ``PN`` is ``bash-native``. Using ``bash`` to build
  4462. packages for the target and for Multilib, ``PN`` would be ``bash``
  4463. and ``lib64-bash``, respectively.
  4464. :term:`PNBLACKLIST`
  4465. Lists recipes you do not want the OpenEmbedded build system to build.
  4466. This variable works in conjunction with the
  4467. :ref:`blacklist <ref-classes-blacklist>` class, which is inherited
  4468. globally.
  4469. To prevent a recipe from being built, use the ``PNBLACKLIST``
  4470. variable in your ``local.conf`` file. Here is an example that
  4471. prevents ``myrecipe`` from being built:
  4472. ::
  4473. PNBLACKLIST[myrecipe] = "Not supported by our organization."
  4474. :term:`POPULATE_SDK_POST_HOST_COMMAND`
  4475. Specifies a list of functions to call once the OpenEmbedded build
  4476. system has created the host part of the SDK. You can specify
  4477. functions separated by semicolons:
  4478. ::
  4479. POPULATE_SDK_POST_HOST_COMMAND += "function; ... "
  4480. If you need to pass the SDK path to a command within a function, you
  4481. can use ``${SDK_DIR}``, which points to the parent directory used by
  4482. the OpenEmbedded build system when creating SDK output. See the
  4483. :term:`SDK_DIR` variable for more information.
  4484. :term:`POPULATE_SDK_POST_TARGET_COMMAND`
  4485. Specifies a list of functions to call once the OpenEmbedded build
  4486. system has created the target part of the SDK. You can specify
  4487. functions separated by semicolons:
  4488. ::
  4489. POPULATE_SDK_POST_TARGET_COMMAND += "function; ... "
  4490. If you need to pass the SDK path to a command within a function, you
  4491. can use ``${SDK_DIR}``, which points to the parent directory used by
  4492. the OpenEmbedded build system when creating SDK output. See the
  4493. :term:`SDK_DIR` variable for more information.
  4494. :term:`PR`
  4495. The revision of the recipe. The default value for this variable is
  4496. "r0". Subsequent revisions of the recipe conventionally have the
  4497. values "r1", "r2", and so forth. When :term:`PV` increases,
  4498. ``PR`` is conventionally reset to "r0".
  4499. .. note::
  4500. The OpenEmbedded build system does not need the aid of ``PR``
  4501. to know when to rebuild a recipe. The build system uses the task
  4502. :ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the
  4503. :ref:`stamp <structure-build-tmp-stamps>` and
  4504. :ref:`overview-manual/concepts:shared state cache`
  4505. mechanisms.
  4506. The ``PR`` variable primarily becomes significant when a package
  4507. manager dynamically installs packages on an already built image. In
  4508. this case, ``PR``, which is the default value of
  4509. :term:`PKGR`, helps the package manager distinguish which
  4510. package is the most recent one in cases where many packages have the
  4511. same ``PV`` (i.e. ``PKGV``). A component having many packages with
  4512. the same ``PV`` usually means that the packages all install the same
  4513. upstream version, but with later (``PR``) version packages including
  4514. packaging fixes.
  4515. .. note::
  4516. ``PR`` does not need to be increased for changes that do not change the
  4517. package contents or metadata.
  4518. Because manually managing ``PR`` can be cumbersome and error-prone,
  4519. an automated solution exists. See the
  4520. ":ref:`dev-manual/common-tasks:working with a pr service`" section
  4521. in the Yocto Project Development Tasks Manual for more information.
  4522. :term:`PREFERRED_PROVIDER`
  4523. If multiple recipes provide the same item, this variable determines
  4524. which recipe is preferred and thus provides the item (i.e. the
  4525. preferred provider). You should always suffix this variable with the
  4526. name of the provided item. And, you should define the variable using
  4527. the preferred recipe's name (:term:`PN`). Here is a common
  4528. example:
  4529. ::
  4530. PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
  4531. In the previous example, multiple recipes are providing "virtual/kernel".
  4532. The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of
  4533. the recipe you prefer to provide "virtual/kernel".
  4534. Following are more examples:
  4535. ::
  4536. PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
  4537. PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
  4538. For more
  4539. information, see the ":ref:`dev-manual/common-tasks:using virtual providers`"
  4540. section in the Yocto Project Development Tasks Manual.
  4541. .. note::
  4542. If you use a ``virtual/\*`` item with ``PREFERRED_PROVIDER``, then any
  4543. recipe that :term:`PROVIDES` that item but is not selected (defined)
  4544. by ``PREFERRED_PROVIDER`` is prevented from building, which is usually
  4545. desirable since this mechanism is designed to select between mutually
  4546. exclusive alternative providers.
  4547. :term:`PREFERRED_VERSION`
  4548. If multiple versions of recipes exist, this variable determines which
  4549. version is given preference. You must always suffix the variable with
  4550. the :term:`PN` you want to select, and you should set the
  4551. :term:`PV` accordingly for precedence.
  4552. The ``PREFERRED_VERSION`` variable supports limited wildcard use
  4553. through the "``%``" character. You can use the character to match any
  4554. number of characters, which can be useful when specifying versions
  4555. that contain long revision numbers that potentially change. Here are
  4556. two examples:
  4557. ::
  4558. PREFERRED_VERSION_python = "3.4.0"
  4559. PREFERRED_VERSION_linux-yocto = "5.0%"
  4560. .. note::
  4561. The use of the "%" character is limited in that it only works at the end of the
  4562. string. You cannot use the wildcard character in any other
  4563. location of the string.
  4564. The specified version is matched against :term:`PV`, which
  4565. does not necessarily match the version part of the recipe's filename.
  4566. For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb``
  4567. where ``foo_git.bb`` contains the following assignment:
  4568. ::
  4569. PV = "1.1+git${SRCPV}"
  4570. In this case, the correct way to select
  4571. ``foo_git.bb`` is by using an assignment such as the following:
  4572. ::
  4573. PREFERRED_VERSION_foo = "1.1+git%"
  4574. Compare that previous example
  4575. against the following incorrect example, which does not work:
  4576. ::
  4577. PREFERRED_VERSION_foo = "git"
  4578. Sometimes the ``PREFERRED_VERSION`` variable can be set by
  4579. configuration files in a way that is hard to change. You can use
  4580. :term:`OVERRIDES` to set a machine-specific
  4581. override. Here is an example:
  4582. ::
  4583. PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%"
  4584. Although not recommended, worst case, you can also use the
  4585. "forcevariable" override, which is the strongest override possible.
  4586. Here is an example:
  4587. ::
  4588. PREFERRED_VERSION_linux-yocto_forcevariable = "5.0%"
  4589. .. note::
  4590. The ``\_forcevariable`` override is not handled specially. This override
  4591. only works because the default value of ``OVERRIDES`` includes "forcevariable".
  4592. :term:`PREMIRRORS`
  4593. Specifies additional paths from which the OpenEmbedded build system
  4594. gets source code. When the build system searches for source code, it
  4595. first tries the local download directory. If that location fails, the
  4596. build system tries locations defined by ``PREMIRRORS``, the upstream
  4597. source, and then locations specified by
  4598. :term:`MIRRORS` in that order.
  4599. Assuming your distribution (:term:`DISTRO`) is "poky",
  4600. the default value for ``PREMIRRORS`` is defined in the
  4601. ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository.
  4602. Typically, you could add a specific server for the build system to
  4603. attempt before any others by adding something like the following to
  4604. the ``local.conf`` configuration file in the
  4605. :term:`Build Directory`:
  4606. ::
  4607. PREMIRRORS_prepend = "\
  4608. git://.*/.* http://www.yoctoproject.org/sources/ \n \
  4609. ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
  4610. http://.*/.* http://www.yoctoproject.org/sources/ \n \
  4611. https://.*/.* http://www.yoctoproject.org/sources/ \n"
  4612. These changes cause the
  4613. build system to intercept Git, FTP, HTTP, and HTTPS requests and
  4614. direct them to the ``http://`` sources mirror. You can use
  4615. ``file://`` URLs to point to local directories or network shares as
  4616. well.
  4617. :term:`PRIORITY`
  4618. Indicates the importance of a package.
  4619. ``PRIORITY`` is considered to be part of the distribution policy
  4620. because the importance of any given recipe depends on the purpose for
  4621. which the distribution is being produced. Thus, ``PRIORITY`` is not
  4622. normally set within recipes.
  4623. You can set ``PRIORITY`` to "required", "standard", "extra", and
  4624. "optional", which is the default.
  4625. :term:`PRIVATE_LIBS`
  4626. Specifies libraries installed within a recipe that should be ignored
  4627. by the OpenEmbedded build system's shared library resolver. This
  4628. variable is typically used when software being built by a recipe has
  4629. its own private versions of a library normally provided by another
  4630. recipe. In this case, you would not want the package containing the
  4631. private libraries to be set as a dependency on other unrelated
  4632. packages that should instead depend on the package providing the
  4633. standard version of the library.
  4634. Libraries specified in this variable should be specified by their
  4635. file name. For example, from the Firefox recipe in meta-browser:
  4636. ::
  4637. PRIVATE_LIBS = "libmozjs.so \
  4638. libxpcom.so \
  4639. libnspr4.so \
  4640. libxul.so \
  4641. libmozalloc.so \
  4642. libplc4.so \
  4643. libplds4.so"
  4644. For more information, see the
  4645. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  4646. section in the Yocto Project Overview and Concepts Manual.
  4647. :term:`PROVIDES`
  4648. A list of aliases by which a particular recipe can be known. By
  4649. default, a recipe's own ``PN`` is implicitly already in its
  4650. ``PROVIDES`` list and therefore does not need to mention that it
  4651. provides itself. If a recipe uses ``PROVIDES``, the additional
  4652. aliases are synonyms for the recipe and can be useful for satisfying
  4653. dependencies of other recipes during the build as specified by
  4654. ``DEPENDS``.
  4655. Consider the following example ``PROVIDES`` statement from the recipe
  4656. file ``eudev_3.2.9.bb``:
  4657. ::
  4658. PROVIDES = "udev"
  4659. The ``PROVIDES`` statement
  4660. results in the "eudev" recipe also being available as simply "udev".
  4661. .. note::
  4662. Given that a recipe's own recipe name is already implicitly in its
  4663. own PROVIDES list, it is unnecessary to add aliases with the "+=" operator;
  4664. using a simple assignment will be sufficient. In other words,
  4665. while you could write:
  4666. ::
  4667. PROVIDES += "udev"
  4668. in the above, the "+=" is overkill and unnecessary.
  4669. In addition to providing recipes under alternate names, the
  4670. ``PROVIDES`` mechanism is also used to implement virtual targets. A
  4671. virtual target is a name that corresponds to some particular
  4672. functionality (e.g. a Linux kernel). Recipes that provide the
  4673. functionality in question list the virtual target in ``PROVIDES``.
  4674. Recipes that depend on the functionality in question can include the
  4675. virtual target in ``DEPENDS`` to leave the choice of provider open.
  4676. Conventionally, virtual targets have names on the form
  4677. "virtual/function" (e.g. "virtual/kernel"). The slash is simply part
  4678. of the name and has no syntactical significance.
  4679. The :term:`PREFERRED_PROVIDER` variable is
  4680. used to select which particular recipe provides a virtual target.
  4681. .. note::
  4682. A corresponding mechanism for virtual runtime dependencies
  4683. (packages) exists. However, the mechanism does not depend on any
  4684. special functionality beyond ordinary variable assignments. For
  4685. example, ``VIRTUAL-RUNTIME_dev_manager`` refers to the package of
  4686. the component that manages the ``/dev`` directory.
  4687. Setting the "preferred provider" for runtime dependencies is as
  4688. simple as using the following assignment in a configuration file:
  4689. ::
  4690. VIRTUAL-RUNTIME_dev_manager = "udev"
  4691. :term:`PRSERV_HOST`
  4692. The network based :term:`PR` service host and port.
  4693. The ``conf/local.conf.sample.extended`` configuration file in the
  4694. :term:`Source Directory` shows how the
  4695. ``PRSERV_HOST`` variable is set:
  4696. ::
  4697. PRSERV_HOST = "localhost:0"
  4698. You must
  4699. set the variable if you want to automatically start a local :ref:`PR
  4700. service <dev-manual/common-tasks:working with a pr service>`. You can
  4701. set ``PRSERV_HOST`` to other values to use a remote PR service.
  4702. :term:`PSEUDO_IGNORE_PATHS`
  4703. A comma-separated (without spaces) list of path prefixes that should be ignored
  4704. by pseudo when monitoring and recording file operations, in order to avoid
  4705. problems with files being written to outside of the pseudo context and
  4706. reduce pseudo's overhead. A path is ignored if it matches any prefix in the list
  4707. and can include partial directory (or file) names.
  4708. :term:`PTEST_ENABLED`
  4709. Specifies whether or not :ref:`Package
  4710. Test <dev-manual/common-tasks:testing packages with ptest>` (ptest)
  4711. functionality is enabled when building a recipe. You should not set
  4712. this variable directly. Enabling and disabling building Package Tests
  4713. at build time should be done by adding "ptest" to (or removing it
  4714. from) :term:`DISTRO_FEATURES`.
  4715. :term:`PV`
  4716. The version of the recipe. The version is normally extracted from the
  4717. recipe filename. For example, if the recipe is named
  4718. ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1".
  4719. ``PV`` is generally not overridden within a recipe unless it is
  4720. building an unstable (i.e. development) version from a source code
  4721. repository (e.g. Git or Subversion).
  4722. ``PV`` is the default value of the :term:`PKGV` variable.
  4723. :term:`PYTHON_ABI`
  4724. When used by recipes that inherit the
  4725. :ref:`distutils3 <ref-classes-distutils3>`,
  4726. :ref:`setuptools3 <ref-classes-setuptools3>`,
  4727. :ref:`distutils <ref-classes-distutils>`, or
  4728. :ref:`setuptools <ref-classes-setuptools>` classes, denotes the
  4729. Application Binary Interface (ABI) currently in use for Python. By
  4730. default, the ABI is "m". You do not have to set this variable as the
  4731. OpenEmbedded build system sets it for you.
  4732. The OpenEmbedded build system uses the ABI to construct directory
  4733. names used when installing the Python headers and libraries in
  4734. sysroot (e.g. ``.../python3.3m/...``).
  4735. Recipes that inherit the ``distutils`` class during cross-builds also
  4736. use this variable to locate the headers and libraries of the
  4737. appropriate Python that the extension is targeting.
  4738. :term:`PYTHON_PN`
  4739. When used by recipes that inherit the
  4740. `distutils3 <ref-classes-distutils3>`,
  4741. :ref:`setuptools3 <ref-classes-setuptools3>`,
  4742. :ref:`distutils <ref-classes-distutils>`, or
  4743. :ref:`setuptools <ref-classes-setuptools>` classes, specifies the
  4744. major Python version being built. For Python 3.x, ``PYTHON_PN`` would
  4745. be "python3". You do not have to set this variable as the
  4746. OpenEmbedded build system automatically sets it for you.
  4747. The variable allows recipes to use common infrastructure such as the
  4748. following:
  4749. ::
  4750. DEPENDS += "${PYTHON_PN}-native"
  4751. In the previous example,
  4752. the version of the dependency is ``PYTHON_PN``.
  4753. :term:`RANLIB`
  4754. The minimal command and arguments to run ``ranlib``.
  4755. :term:`RCONFLICTS`
  4756. The list of packages that conflict with packages. Note that packages
  4757. will not be installed if conflicting packages are not first removed.
  4758. Like all package-controlling variables, you must always use them in
  4759. conjunction with a package name override. Here is an example:
  4760. ::
  4761. RCONFLICTS_${PN} = "another_conflicting_package_name"
  4762. BitBake, which the OpenEmbedded build system uses, supports
  4763. specifying versioned dependencies. Although the syntax varies
  4764. depending on the packaging format, BitBake hides these differences
  4765. from you. Here is the general syntax to specify versions with the
  4766. ``RCONFLICTS`` variable:
  4767. ::
  4768. RCONFLICTS_${PN} = "package (operator version)"
  4769. For ``operator``, you can specify the following:
  4770. - =
  4771. - <
  4772. - >
  4773. - <=
  4774. - >=
  4775. For example, the following sets up a dependency on version 1.2 or
  4776. greater of the package ``foo``:
  4777. ::
  4778. RCONFLICTS_${PN} = "foo (>= 1.2)"
  4779. :term:`RDEPENDS`
  4780. Lists runtime dependencies of a package. These dependencies are other
  4781. packages that must be installed in order for the package to function
  4782. correctly. As an example, the following assignment declares that the
  4783. package ``foo`` needs the packages ``bar`` and ``baz`` to be
  4784. installed:
  4785. ::
  4786. RDEPENDS_foo = "bar baz"
  4787. The most common types of package
  4788. runtime dependencies are automatically detected and added. Therefore,
  4789. most recipes do not need to set ``RDEPENDS``. For more information,
  4790. see the
  4791. ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
  4792. section in the Yocto Project Overview and Concepts Manual.
  4793. The practical effect of the above ``RDEPENDS`` assignment is that
  4794. ``bar`` and ``baz`` will be declared as dependencies inside the
  4795. package ``foo`` when it is written out by one of the
  4796. :ref:`do_package_write_\* <ref-tasks-package_write_deb>` tasks.
  4797. Exactly how this is done depends on which package format is used,
  4798. which is determined by
  4799. :term:`PACKAGE_CLASSES`. When the
  4800. corresponding package manager installs the package, it will know to
  4801. also install the packages on which it depends.
  4802. To ensure that the packages ``bar`` and ``baz`` get built, the
  4803. previous ``RDEPENDS`` assignment also causes a task dependency to be
  4804. added. This dependency is from the recipe's
  4805. :ref:`ref-tasks-build` (not to be confused with
  4806. :ref:`ref-tasks-compile`) task to the
  4807. ``do_package_write_*`` task of the recipes that build ``bar`` and
  4808. ``baz``.
  4809. The names of the packages you list within ``RDEPENDS`` must be the
  4810. names of other packages - they cannot be recipe names. Although
  4811. package names and recipe names usually match, the important point
  4812. here is that you are providing package names within the ``RDEPENDS``
  4813. variable. For an example of the default list of packages created from
  4814. a recipe, see the :term:`PACKAGES` variable.
  4815. Because the ``RDEPENDS`` variable applies to packages being built,
  4816. you should always use the variable in a form with an attached package
  4817. name (remember that a single recipe can build multiple packages). For
  4818. example, suppose you are building a development package that depends
  4819. on the ``perl`` package. In this case, you would use the following
  4820. ``RDEPENDS`` statement:
  4821. ::
  4822. RDEPENDS_${PN}-dev += "perl"
  4823. In the example,
  4824. the development package depends on the ``perl`` package. Thus, the
  4825. ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part of
  4826. the variable.
  4827. .. note::
  4828. ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}``
  4829. by default. This default is set in the BitBake configuration file
  4830. (``meta/conf/bitbake.conf``). Be careful not to accidentally remove
  4831. ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator
  4832. rather than the "=" operator.
  4833. The package names you use with ``RDEPENDS`` must appear as they would
  4834. in the ``PACKAGES`` variable. The :term:`PKG` variable
  4835. allows a different name to be used for the final package (e.g. the
  4836. :ref:`debian <ref-classes-debian>` class uses this to rename
  4837. packages), but this final package name cannot be used with
  4838. ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be
  4839. independent of the package format used.
  4840. BitBake, which the OpenEmbedded build system uses, supports
  4841. specifying versioned dependencies. Although the syntax varies
  4842. depending on the packaging format, BitBake hides these differences
  4843. from you. Here is the general syntax to specify versions with the
  4844. ``RDEPENDS`` variable:
  4845. ::
  4846. RDEPENDS_${PN} = "package (operator version)"
  4847. For ``operator``, you can specify the following:
  4848. - =
  4849. - <
  4850. - >
  4851. - <=
  4852. - >=
  4853. For version, provide the version number.
  4854. .. note::
  4855. You can use ``EXTENDPKGV`` to provide a full package version
  4856. specification.
  4857. For example, the following sets up a dependency on version 1.2 or
  4858. greater of the package ``foo``:
  4859. ::
  4860. RDEPENDS_${PN} = "foo (>= 1.2)"
  4861. For information on build-time dependencies, see the
  4862. :term:`DEPENDS` variable. You can also see the
  4863. ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and
  4864. ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the
  4865. BitBake User Manual for additional information on tasks and
  4866. dependencies.
  4867. :term:`REQUIRED_DISTRO_FEATURES`
  4868. When inheriting the
  4869. :ref:`features_check <ref-classes-features_check>`
  4870. class, this variable identifies distribution features that must exist
  4871. in the current configuration in order for the OpenEmbedded build
  4872. system to build the recipe. In other words, if the
  4873. ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not
  4874. appear in ``DISTRO_FEATURES`` within the current configuration, then
  4875. the recipe will be skipped, and if the build system attempts to build
  4876. the recipe then an error will be triggered.
  4877. :term:`RM_WORK_EXCLUDE`
  4878. With ``rm_work`` enabled, this variable specifies a list of recipes
  4879. whose work directories should not be removed. See the
  4880. ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more
  4881. details.
  4882. :term:`ROOT_HOME`
  4883. Defines the root home directory. By default, this directory is set as
  4884. follows in the BitBake configuration file:
  4885. ::
  4886. ROOT_HOME ??= "/home/root"
  4887. .. note::
  4888. This default value is likely used because some embedded solutions
  4889. prefer to have a read-only root filesystem and prefer to keep
  4890. writeable data in one place.
  4891. You can override the default by setting the variable in any layer or
  4892. in the ``local.conf`` file. Because the default is set using a "weak"
  4893. assignment (i.e. "??="), you can use either of the following forms to
  4894. define your override:
  4895. ::
  4896. ROOT_HOME = "/root"
  4897. ROOT_HOME ?= "/root"
  4898. These
  4899. override examples use ``/root``, which is probably the most commonly
  4900. used override.
  4901. :term:`ROOTFS`
  4902. Indicates a filesystem image to include as the root filesystem.
  4903. The ``ROOTFS`` variable is an optional variable used with the
  4904. :ref:`image-live <ref-classes-image-live>` class.
  4905. :term:`ROOTFS_POSTINSTALL_COMMAND`
  4906. Specifies a list of functions to call after the OpenEmbedded build
  4907. system has installed packages. You can specify functions separated by
  4908. semicolons:
  4909. ::
  4910. ROOTFS_POSTINSTALL_COMMAND += "function; ... "
  4911. If you need to pass the root filesystem path to a command within a
  4912. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  4913. directory that becomes the root filesystem image. See the
  4914. :term:`IMAGE_ROOTFS` variable for more
  4915. information.
  4916. :term:`ROOTFS_POSTPROCESS_COMMAND`
  4917. Specifies a list of functions to call once the OpenEmbedded build
  4918. system has created the root filesystem. You can specify functions
  4919. separated by semicolons:
  4920. ::
  4921. ROOTFS_POSTPROCESS_COMMAND += "function; ... "
  4922. If you need to pass the root filesystem path to a command within a
  4923. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  4924. directory that becomes the root filesystem image. See the
  4925. :term:`IMAGE_ROOTFS` variable for more
  4926. information.
  4927. :term:`ROOTFS_POSTUNINSTALL_COMMAND`
  4928. Specifies a list of functions to call after the OpenEmbedded build
  4929. system has removed unnecessary packages. When runtime package
  4930. management is disabled in the image, several packages are removed
  4931. including ``base-passwd``, ``shadow``, and ``update-alternatives``.
  4932. You can specify functions separated by semicolons:
  4933. ::
  4934. ROOTFS_POSTUNINSTALL_COMMAND += "function; ... "
  4935. If you need to pass the root filesystem path to a command within a
  4936. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  4937. directory that becomes the root filesystem image. See the
  4938. :term:`IMAGE_ROOTFS` variable for more
  4939. information.
  4940. :term:`ROOTFS_PREPROCESS_COMMAND`
  4941. Specifies a list of functions to call before the OpenEmbedded build
  4942. system has created the root filesystem. You can specify functions
  4943. separated by semicolons:
  4944. ::
  4945. ROOTFS_PREPROCESS_COMMAND += "function; ... "
  4946. If you need to pass the root filesystem path to a command within a
  4947. function, you can use ``${IMAGE_ROOTFS}``, which points to the
  4948. directory that becomes the root filesystem image. See the
  4949. :term:`IMAGE_ROOTFS` variable for more
  4950. information.
  4951. :term:`RPROVIDES`
  4952. A list of package name aliases that a package also provides. These
  4953. aliases are useful for satisfying runtime dependencies of other
  4954. packages both during the build and on the target (as specified by
  4955. ``RDEPENDS``).
  4956. .. note::
  4957. A package's own name is implicitly already in its ``RPROVIDES`` list.
  4958. As with all package-controlling variables, you must always use the
  4959. variable in conjunction with a package name override. Here is an
  4960. example:
  4961. ::
  4962. RPROVIDES_${PN} = "widget-abi-2"
  4963. :term:`RRECOMMENDS`
  4964. A list of packages that extends the usability of a package being
  4965. built. The package being built does not depend on this list of
  4966. packages in order to successfully build, but rather uses them for
  4967. extended usability. To specify runtime dependencies for packages, see
  4968. the ``RDEPENDS`` variable.
  4969. The package manager will automatically install the ``RRECOMMENDS``
  4970. list of packages when installing the built package. However, you can
  4971. prevent listed packages from being installed by using the
  4972. :term:`BAD_RECOMMENDATIONS`,
  4973. :term:`NO_RECOMMENDATIONS`, and
  4974. :term:`PACKAGE_EXCLUDE` variables.
  4975. Packages specified in ``RRECOMMENDS`` need not actually be produced.
  4976. However, a recipe must exist that provides each package, either
  4977. through the :term:`PACKAGES` or
  4978. :term:`PACKAGES_DYNAMIC` variables or the
  4979. :term:`RPROVIDES` variable, or an error will occur
  4980. during the build. If such a recipe does exist and the package is not
  4981. produced, the build continues without error.
  4982. Because the ``RRECOMMENDS`` variable applies to packages being built,
  4983. you should always attach an override to the variable to specify the
  4984. particular package whose usability is being extended. For example,
  4985. suppose you are building a development package that is extended to
  4986. support wireless functionality. In this case, you would use the
  4987. following:
  4988. ::
  4989. RRECOMMENDS_${PN}-dev += "wireless_package_name"
  4990. In the
  4991. example, the package name (``${PN}-dev``) must appear as it would in
  4992. the ``PACKAGES`` namespace before any renaming of the output package
  4993. by classes such as ``debian.bbclass``.
  4994. BitBake, which the OpenEmbedded build system uses, supports
  4995. specifying versioned recommends. Although the syntax varies depending
  4996. on the packaging format, BitBake hides these differences from you.
  4997. Here is the general syntax to specify versions with the
  4998. ``RRECOMMENDS`` variable:
  4999. ::
  5000. RRECOMMENDS_${PN} = "package (operator version)"
  5001. For ``operator``, you can specify the following:
  5002. - =
  5003. - <
  5004. - >
  5005. - <=
  5006. - >=
  5007. For example, the following sets up a recommend on version 1.2 or
  5008. greater of the package ``foo``:
  5009. ::
  5010. RRECOMMENDS_${PN} = "foo (>= 1.2)"
  5011. :term:`RREPLACES`
  5012. A list of packages replaced by a package. The package manager uses
  5013. this variable to determine which package should be installed to
  5014. replace other package(s) during an upgrade. In order to also have the
  5015. other package(s) removed at the same time, you must add the name of
  5016. the other package to the ``RCONFLICTS`` variable.
  5017. As with all package-controlling variables, you must use this variable
  5018. in conjunction with a package name override. Here is an example:
  5019. ::
  5020. RREPLACES_${PN} = "other_package_being_replaced"
  5021. BitBake, which the OpenEmbedded build system uses, supports
  5022. specifying versioned replacements. Although the syntax varies
  5023. depending on the packaging format, BitBake hides these differences
  5024. from you. Here is the general syntax to specify versions with the
  5025. ``RREPLACES`` variable:
  5026. ::
  5027. RREPLACES_${PN} = "package (operator version)"
  5028. For ``operator``, you can specify the following:
  5029. - =
  5030. - <
  5031. - >
  5032. - <=
  5033. - >=
  5034. For example, the following sets up a replacement using version 1.2
  5035. or greater of the package ``foo``:
  5036. ::
  5037. RREPLACES_${PN} = "foo (>= 1.2)"
  5038. :term:`RSUGGESTS`
  5039. A list of additional packages that you can suggest for installation
  5040. by the package manager at the time a package is installed. Not all
  5041. package managers support this functionality.
  5042. As with all package-controlling variables, you must always use this
  5043. variable in conjunction with a package name override. Here is an
  5044. example:
  5045. ::
  5046. RSUGGESTS_${PN} = "useful_package another_package"
  5047. :term:`S`
  5048. The location in the :term:`Build Directory` where
  5049. unpacked recipe source code resides. By default, this directory is
  5050. ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
  5051. where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe
  5052. version. If the source tarball extracts the code to a directory named
  5053. anything other than ``${BPN}-${PV}``, or if the source code is
  5054. fetched from an SCM such as Git or Subversion, then you must set
  5055. ``S`` in the recipe so that the OpenEmbedded build system knows where
  5056. to find the unpacked source.
  5057. As an example, assume a :term:`Source Directory`
  5058. top-level folder named ``poky`` and a default Build Directory at
  5059. ``poky/build``. In this case, the work directory the build system
  5060. uses to keep the unpacked recipe for ``db`` is the following:
  5061. ::
  5062. poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
  5063. The unpacked source code resides in the ``db-5.1.19`` folder.
  5064. This next example assumes a Git repository. By default, Git
  5065. repositories are cloned to ``${WORKDIR}/git`` during
  5066. :ref:`ref-tasks-fetch`. Since this path is different
  5067. from the default value of ``S``, you must set it specifically so the
  5068. source can be located:
  5069. ::
  5070. SRC_URI = "git://path/to/repo.git"
  5071. S = "${WORKDIR}/git"
  5072. :term:`SANITY_REQUIRED_UTILITIES`
  5073. Specifies a list of command-line utilities that should be checked for
  5074. during the initial sanity checking process when running BitBake. If
  5075. any of the utilities are not installed on the build host, then
  5076. BitBake immediately exits with an error.
  5077. :term:`SANITY_TESTED_DISTROS`
  5078. A list of the host distribution identifiers that the build system has
  5079. been tested against. Identifiers consist of the host distributor ID
  5080. followed by the release, as reported by the ``lsb_release`` tool or
  5081. as read from ``/etc/lsb-release``. Separate the list items with
  5082. explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is
  5083. not empty and the current value of
  5084. :term:`NATIVELSBSTRING` does not appear in the
  5085. list, then the build system reports a warning that indicates the
  5086. current host distribution has not been tested as a build host.
  5087. :term:`SDK_ARCH`
  5088. The target architecture for the SDK. Typically, you do not directly
  5089. set this variable. Instead, use :term:`SDKMACHINE`.
  5090. :term:`SDK_DEPLOY`
  5091. The directory set up and used by the
  5092. :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which
  5093. the SDK is deployed. The ``populate_sdk_base`` class defines
  5094. ``SDK_DEPLOY`` as follows:
  5095. ::
  5096. SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
  5097. :term:`SDK_DIR`
  5098. The parent directory used by the OpenEmbedded build system when
  5099. creating SDK output. The
  5100. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines
  5101. the variable as follows:
  5102. ::
  5103. SDK_DIR = "${WORKDIR}/sdk"
  5104. .. note::
  5105. The ``SDK_DIR`` directory is a temporary directory as it is part of
  5106. ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`.
  5107. :term:`SDK_EXT_TYPE`
  5108. Controls whether or not shared state artifacts are copied into the
  5109. extensible SDK. The default value of "full" copies all of the
  5110. required shared state artifacts into the extensible SDK. The value
  5111. "minimal" leaves these artifacts out of the SDK.
  5112. .. note::
  5113. If you set the variable to "minimal", you need to ensure
  5114. :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the
  5115. artifacts to be fetched as needed.
  5116. :term:`SDK_HOST_MANIFEST`
  5117. The manifest file for the host part of the SDK. This file lists all
  5118. the installed packages that make up the host part of the SDK. The
  5119. file contains package information on a line-per-package basis as
  5120. follows:
  5121. ::
  5122. packagename packagearch version
  5123. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class
  5124. defines the manifest file as follows:
  5125. ::
  5126. SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest"
  5127. The location is derived using the :term:`SDK_DEPLOY` and
  5128. :term:`TOOLCHAIN_OUTPUTNAME` variables.
  5129. :term:`SDK_INCLUDE_PKGDATA`
  5130. When set to "1", specifies to include the packagedata for all recipes
  5131. in the "world" target in the extensible SDK. Including this data
  5132. allows the ``devtool search`` command to find these recipes in search
  5133. results, as well as allows the ``devtool add`` command to map
  5134. dependencies more effectively.
  5135. .. note::
  5136. Enabling the ``SDK_INCLUDE_PKGDATA``
  5137. variable significantly increases build time because all of world
  5138. needs to be built. Enabling the variable also slightly increases
  5139. the size of the extensible SDK.
  5140. :term:`SDK_INCLUDE_TOOLCHAIN`
  5141. When set to "1", specifies to include the toolchain in the extensible
  5142. SDK. Including the toolchain is useful particularly when
  5143. :term:`SDK_EXT_TYPE` is set to "minimal" to keep
  5144. the SDK reasonably small but you still want to provide a usable
  5145. toolchain. For example, suppose you want to use the toolchain from an
  5146. IDE or from other tools and you do not want to perform additional
  5147. steps to install the toolchain.
  5148. The ``SDK_INCLUDE_TOOLCHAIN`` variable defaults to "0" if
  5149. ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if
  5150. ``SDK_EXT_TYPE`` is set to "full".
  5151. :term:`SDK_INHERIT_BLACKLIST`
  5152. A list of classes to remove from the :term:`INHERIT`
  5153. value globally within the extensible SDK configuration. The
  5154. :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the
  5155. default value:
  5156. ::
  5157. SDK_INHERIT_BLACKLIST ?= "buildhistory icecc"
  5158. Some classes are not generally applicable within the extensible SDK
  5159. context. You can use this variable to disable those classes.
  5160. For additional information on how to customize the extensible SDK's
  5161. configuration, see the
  5162. ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
  5163. section in the Yocto Project Application Development and the
  5164. Extensible Software Development Kit (eSDK) manual.
  5165. :term:`SDK_LOCAL_CONF_BLACKLIST`
  5166. A list of variables not allowed through from the OpenEmbedded build
  5167. system configuration into the extensible SDK configuration. Usually,
  5168. these are variables that are specific to the machine on which the
  5169. build system is running and thus would be potentially problematic
  5170. within the extensible SDK.
  5171. By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the
  5172. :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and
  5173. excludes the following variables:
  5174. - :term:`CONF_VERSION`
  5175. - :term:`BB_NUMBER_THREADS`
  5176. - :term:`bitbake:BB_NUMBER_PARSE_THREADS`
  5177. - :term:`PARALLEL_MAKE`
  5178. - :term:`PRSERV_HOST`
  5179. - :term:`SSTATE_MIRRORS` :term:`DL_DIR`
  5180. - :term:`SSTATE_DIR` :term:`TMPDIR`
  5181. - :term:`BB_SERVER_TIMEOUT`
  5182. For additional information on how to customize the extensible SDK's
  5183. configuration, see the
  5184. ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
  5185. section in the Yocto Project Application Development and the
  5186. Extensible Software Development Kit (eSDK) manual.
  5187. :term:`SDK_LOCAL_CONF_WHITELIST`
  5188. A list of variables allowed through from the OpenEmbedded build
  5189. system configuration into the extensible SDK configuration. By
  5190. default, the list of variables is empty and is set in the
  5191. :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
  5192. This list overrides the variables specified using the
  5193. :term:`SDK_LOCAL_CONF_BLACKLIST`
  5194. variable as well as any variables identified by automatic
  5195. blacklisting due to the "/" character being found at the start of the
  5196. value, which is usually indicative of being a path and thus might not
  5197. be valid on the system where the SDK is installed.
  5198. For additional information on how to customize the extensible SDK's
  5199. configuration, see the
  5200. ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
  5201. section in the Yocto Project Application Development and the
  5202. Extensible Software Development Kit (eSDK) manual.
  5203. :term:`SDK_NAME`
  5204. The base name for SDK output files. The name is derived from the
  5205. :term:`DISTRO`, :term:`TCLIBC`,
  5206. :term:`SDK_ARCH`,
  5207. :term:`IMAGE_BASENAME`, and
  5208. :term:`TUNE_PKGARCH` variables:
  5209. ::
  5210. SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}"
  5211. :term:`SDK_OS`
  5212. Specifies the operating system for which the SDK will be built. The
  5213. default value is the value of :term:`BUILD_OS`.
  5214. :term:`SDK_OUTPUT`
  5215. The location used by the OpenEmbedded build system when creating SDK
  5216. output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
  5217. class defines the variable as follows:
  5218. ::
  5219. SDK_DIR = "${WORKDIR}/sdk"
  5220. SDK_OUTPUT = "${SDK_DIR}/image"
  5221. SDK_DEPLOY = "${DEPLOY_DIR}/sdk"
  5222. .. note::
  5223. The ``SDK_OUTPUT`` directory is a temporary directory as it is part of
  5224. :term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is
  5225. :term:`SDK_DEPLOY`.
  5226. :term:`SDK_PACKAGE_ARCHS`
  5227. Specifies a list of architectures compatible with the SDK machine.
  5228. This variable is set automatically and should not normally be
  5229. hand-edited. Entries are separated using spaces and listed in order
  5230. of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any
  5231. noarch ${SDK_ARCH}-${SDKPKGSUFFIX}".
  5232. :term:`SDK_POSTPROCESS_COMMAND`
  5233. Specifies a list of functions to call once the OpenEmbedded build
  5234. system creates the SDK. You can specify functions separated by
  5235. semicolons: SDK_POSTPROCESS_COMMAND += "function; ... "
  5236. If you need to pass an SDK path to a command within a function, you
  5237. can use ``${SDK_DIR}``, which points to the parent directory used by
  5238. the OpenEmbedded build system when creating SDK output. See the
  5239. :term:`SDK_DIR` variable for more information.
  5240. :term:`SDK_PREFIX`
  5241. The toolchain binary prefix used for ``nativesdk`` recipes. The
  5242. OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the
  5243. :term:`TARGET_PREFIX` when building
  5244. ``nativesdk`` recipes. The default value is "${SDK_SYS}-".
  5245. :term:`SDK_RECRDEP_TASKS`
  5246. A list of shared state tasks added to the extensible SDK. By default,
  5247. the following tasks are added:
  5248. - do_populate_lic
  5249. - do_package_qa
  5250. - do_populate_sysroot
  5251. - do_deploy
  5252. Despite the default value of "" for the
  5253. ``SDK_RECRDEP_TASKS`` variable, the above four tasks are always added
  5254. to the SDK. To specify tasks beyond these four, you need to use the
  5255. ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional
  5256. tasks that are needed in order to build
  5257. :term:`SDK_TARGETS`).
  5258. :term:`SDK_SYS`
  5259. Specifies the system, including the architecture and the operating
  5260. system, for which the SDK will be built.
  5261. The OpenEmbedded build system automatically sets this variable based
  5262. on :term:`SDK_ARCH`,
  5263. :term:`SDK_VENDOR`, and
  5264. :term:`SDK_OS`. You do not need to set the ``SDK_SYS``
  5265. variable yourself.
  5266. :term:`SDK_TARGET_MANIFEST`
  5267. The manifest file for the target part of the SDK. This file lists all
  5268. the installed packages that make up the target part of the SDK. The
  5269. file contains package information on a line-per-package basis as
  5270. follows:
  5271. ::
  5272. packagename packagearch version
  5273. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class
  5274. defines the manifest file as follows:
  5275. ::
  5276. SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest"
  5277. The location is derived using the :term:`SDK_DEPLOY` and
  5278. :term:`TOOLCHAIN_OUTPUTNAME` variables.
  5279. :term:`SDK_TARGETS`
  5280. A list of targets to install from shared state as part of the
  5281. standard or extensible SDK installation. The default value is "${PN}"
  5282. (i.e. the image from which the SDK is built).
  5283. The ``SDK_TARGETS`` variable is an internal variable and typically
  5284. would not be changed.
  5285. :term:`SDK_TITLE`
  5286. The title to be printed when running the SDK installer. By default,
  5287. this title is based on the :term:`DISTRO_NAME` or
  5288. :term:`DISTRO` variable and is set in the
  5289. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class as
  5290. follows:
  5291. ::
  5292. SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK"
  5293. For the default distribution "poky",
  5294. ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)".
  5295. For information on how to change this default title, see the
  5296. ":ref:`sdk-manual/appendix-customizing:changing the extensible sdk installer title`"
  5297. section in the Yocto Project Application Development and the
  5298. Extensible Software Development Kit (eSDK) manual.
  5299. :term:`SDK_UPDATE_URL`
  5300. An optional URL for an update server for the extensible SDK. If set,
  5301. the value is used as the default update server when running
  5302. ``devtool sdk-update`` within the extensible SDK.
  5303. :term:`SDK_VENDOR`
  5304. Specifies the name of the SDK vendor.
  5305. :term:`SDK_VERSION`
  5306. Specifies the version of the SDK. The distribution configuration file
  5307. (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the
  5308. ``SDK_VERSION`` as follows:
  5309. ::
  5310. SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}"
  5311. For additional information, see the
  5312. :term:`DISTRO_VERSION` and
  5313. :term:`DATE` variables.
  5314. :term:`SDKEXTPATH`
  5315. The default installation directory for the Extensible SDK. By
  5316. default, this directory is based on the :term:`DISTRO`
  5317. variable and is set in the
  5318. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class as
  5319. follows:
  5320. ::
  5321. SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk"
  5322. For the
  5323. default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk".
  5324. For information on how to change this default directory, see the
  5325. ":ref:`sdk-manual/appendix-customizing:changing the default sdk installation directory`"
  5326. section in the Yocto Project Application Development and the
  5327. Extensible Software Development Kit (eSDK) manual.
  5328. :term:`SDKIMAGE_FEATURES`
  5329. Equivalent to ``IMAGE_FEATURES``. However, this variable applies to
  5330. the SDK generated from an image using the following command:
  5331. ::
  5332. $ bitbake -c populate_sdk imagename
  5333. :term:`SDKMACHINE`
  5334. The machine for which the SDK is built. In other words, the SDK is
  5335. built such that it runs on the target you specify with the
  5336. ``SDKMACHINE`` value. The value points to a corresponding ``.conf``
  5337. file under ``conf/machine-sdk/``.
  5338. You can use "i686" and "x86_64" as possible values for this variable.
  5339. The variable defaults to "i686" and is set in the local.conf file in
  5340. the Build Directory.
  5341. ::
  5342. SDKMACHINE ?= "i686"
  5343. .. note::
  5344. You cannot set the ``SDKMACHINE``
  5345. variable in your distribution configuration file. If you do, the
  5346. configuration will not take affect.
  5347. :term:`SDKPATH`
  5348. Defines the path offered to the user for installation of the SDK that
  5349. is generated by the OpenEmbedded build system. The path appears as
  5350. the default location for installing the SDK when you run the SDK's
  5351. installation script. You can override the offered path when you run
  5352. the script.
  5353. :term:`SDKTARGETSYSROOT`
  5354. The full path to the sysroot used for cross-compilation within an SDK
  5355. as it will be when installed into the default
  5356. :term:`SDKPATH`.
  5357. :term:`SECTION`
  5358. The section in which packages should be categorized. Package
  5359. management utilities can make use of this variable.
  5360. :term:`SELECTED_OPTIMIZATION`
  5361. Specifies the optimization flags passed to the C compiler when
  5362. building for the target. The flags are passed through the default
  5363. value of the :term:`TARGET_CFLAGS` variable.
  5364. The ``SELECTED_OPTIMIZATION`` variable takes the value of
  5365. ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the
  5366. case, the value of ``DEBUG_OPTIMIZATION`` is used.
  5367. :term:`SERIAL_CONSOLE`
  5368. Defines a serial console (TTY) to enable using
  5369. `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a
  5370. value that specifies the baud rate followed by the TTY device name
  5371. separated by a space. You cannot specify more than one TTY device:
  5372. ::
  5373. SERIAL_CONSOLE = "115200 ttyS0"
  5374. .. note::
  5375. The ``SERIAL_CONSOLE`` variable is deprecated. Please use the
  5376. :term:`SERIAL_CONSOLES` variable.
  5377. :term:`SERIAL_CONSOLES`
  5378. Defines a serial console (TTY) to enable using
  5379. `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a
  5380. value that specifies the baud rate followed by the TTY device name
  5381. separated by a semicolon. Use spaces to separate multiple devices:
  5382. ::
  5383. SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1"
  5384. :term:`SERIAL_CONSOLES_CHECK`
  5385. Specifies serial consoles, which must be listed in
  5386. :term:`SERIAL_CONSOLES`, to check against
  5387. ``/proc/console`` before enabling them using getty. This variable
  5388. allows aliasing in the format: <device>:<alias>. If a device was
  5389. listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in
  5390. ``/proc/console``, you would do the following: ::
  5391. SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0"
  5392. This variable is currently only supported with SysVinit (i.e. not
  5393. with systemd).
  5394. :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
  5395. A list of recipe dependencies that should not be used to determine
  5396. signatures of tasks from one recipe when they depend on tasks from
  5397. another recipe. For example: ::
  5398. SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
  5399. In the previous example, ``intone`` depends on ``mplayer2``.
  5400. You can use the special token ``"*"`` on the left-hand side of the
  5401. dependency to match all recipes except the one on the right-hand
  5402. side. Here is an example: ::
  5403. SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native"
  5404. In the previous example, all recipes except ``quilt-native`` ignore
  5405. task signatures from the ``quilt-native`` recipe when determining
  5406. their task signatures.
  5407. Use of this variable is one mechanism to remove dependencies that
  5408. affect task signatures and thus force rebuilds when a recipe changes.
  5409. .. note::
  5410. If you add an inappropriate dependency for a recipe relationship,
  5411. the software might break during runtime if the interface of the
  5412. second recipe was changed after the first recipe had been built.
  5413. :term:`SIGGEN_EXCLUDERECIPES_ABISAFE`
  5414. A list of recipes that are completely stable and will never change.
  5415. The ABI for the recipes in the list are presented by output from the
  5416. tasks run to build the recipe. Use of this variable is one way to
  5417. remove dependencies from one recipe on another that affect task
  5418. signatures and thus force rebuilds when the recipe changes.
  5419. .. note::
  5420. If you add an inappropriate variable to this list, the software
  5421. might break at runtime if the interface of the recipe was changed
  5422. after the other had been built.
  5423. :term:`SITEINFO_BITS`
  5424. Specifies the number of bits for the target system CPU. The value
  5425. should be either "32" or "64".
  5426. :term:`SITEINFO_ENDIANNESS`
  5427. Specifies the endian byte order of the target system. The value
  5428. should be either "le" for little-endian or "be" for big-endian.
  5429. :term:`SKIP_FILEDEPS`
  5430. Enables removal of all files from the "Provides" section of an RPM
  5431. package. Removal of these files is required for packages containing
  5432. prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``.
  5433. To enable file removal, set the variable to "1" in your
  5434. ``conf/local.conf`` configuration file in your:
  5435. :term:`Build Directory`.
  5436. ::
  5437. SKIP_FILEDEPS = "1"
  5438. :term:`SOC_FAMILY`
  5439. Groups together machines based upon the same family of SOC (System On
  5440. Chip). You typically set this variable in a common ``.inc`` file that
  5441. you include in the configuration files of all the machines.
  5442. .. note::
  5443. You must include ``conf/machine/include/soc-family.inc`` for this
  5444. variable to appear in :term:`MACHINEOVERRIDES`.
  5445. :term:`SOLIBS`
  5446. Defines the suffix for shared libraries used on the target platform.
  5447. By default, this suffix is ".so.*" for all Linux-based systems and is
  5448. defined in the ``meta/conf/bitbake.conf`` configuration file.
  5449. You will see this variable referenced in the default values of
  5450. ``FILES_${PN}``.
  5451. :term:`SOLIBSDEV`
  5452. Defines the suffix for the development symbolic link (symlink) for
  5453. shared libraries on the target platform. By default, this suffix is
  5454. ".so" for Linux-based systems and is defined in the
  5455. ``meta/conf/bitbake.conf`` configuration file.
  5456. You will see this variable referenced in the default values of
  5457. ``FILES_${PN}-dev``.
  5458. :term:`SOURCE_MIRROR_FETCH`
  5459. When you are fetching files to create a mirror of sources (i.e.
  5460. creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in
  5461. your ``local.conf`` configuration file ensures the source for all
  5462. recipes are fetched regardless of whether or not a recipe is
  5463. compatible with the configuration. A recipe is considered
  5464. incompatible with the currently configured machine when either or
  5465. both the :term:`COMPATIBLE_MACHINE`
  5466. variable and :term:`COMPATIBLE_HOST` variables
  5467. specify compatibility with a machine other than that of the current
  5468. machine or host.
  5469. .. note::
  5470. Do not set the ``SOURCE_MIRROR_FETCH``
  5471. variable unless you are creating a source mirror. In other words,
  5472. do not set the variable during a normal build.
  5473. :term:`SOURCE_MIRROR_URL`
  5474. Defines your own :term:`PREMIRRORS` from which to
  5475. first fetch source before attempting to fetch from the upstream
  5476. specified in :term:`SRC_URI`.
  5477. To use this variable, you must globally inherit the
  5478. :ref:`own-mirrors <ref-classes-own-mirrors>` class and then provide
  5479. the URL to your mirrors. Here is the general syntax:
  5480. ::
  5481. INHERIT += "own-mirrors"
  5482. SOURCE_MIRROR_URL = "http://example.com/my_source_mirror"
  5483. .. note::
  5484. You can specify only a single URL in ``SOURCE_MIRROR_URL``.
  5485. :term:`SPDXLICENSEMAP`
  5486. Maps commonly used license names to their SPDX counterparts found in
  5487. ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP``
  5488. mappings, see the ``meta/conf/licenses.conf`` file.
  5489. For additional information, see the :term:`LICENSE`
  5490. variable.
  5491. :term:`SPECIAL_PKGSUFFIX`
  5492. A list of prefixes for :term:`PN` used by the OpenEmbedded
  5493. build system to create variants of recipes or packages. The list
  5494. specifies the prefixes to strip off during certain circumstances such
  5495. as the generation of the :term:`BPN` variable.
  5496. :term:`SPL_BINARY`
  5497. The file type for the Secondary Program Loader (SPL). Some devices
  5498. use an SPL from which to boot (e.g. the BeagleBone development
  5499. board). For such cases, you can declare the file type of the SPL
  5500. binary in the ``u-boot.inc`` include file, which is used in the
  5501. U-Boot recipe.
  5502. The SPL file type is set to "null" by default in the ``u-boot.inc``
  5503. file as follows:
  5504. ::
  5505. # Some versions of u-boot build an SPL (Second Program Loader) image that
  5506. # should be packaged along with the u-boot binary as well as placed in the
  5507. # deploy directory. For those versions they can set the following variables
  5508. # to allow packaging the SPL.
  5509. SPL_BINARY ?= ""
  5510. SPL_BINARYNAME ?= "${@os.path.basename(d.getVar("SPL_BINARY"))}"
  5511. SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}"
  5512. SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}"
  5513. The ``SPL_BINARY`` variable helps form
  5514. various ``SPL_*`` variables used by the OpenEmbedded build system.
  5515. See the BeagleBone machine configuration example in the
  5516. ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`"
  5517. section in the Yocto Project Board Support Package Developer's Guide
  5518. for additional information.
  5519. :term:`SRC_URI`
  5520. The list of source files - local or remote. This variable tells the
  5521. OpenEmbedded build system which bits to pull in for the build and how
  5522. to pull them in. For example, if the recipe or append file only needs
  5523. to fetch a tarball from the Internet, the recipe or append file uses
  5524. a single ``SRC_URI`` entry. On the other hand, if the recipe or
  5525. append file needs to fetch a tarball, apply two patches, and include
  5526. a custom file, the recipe or append file would include four instances
  5527. of the variable.
  5528. The following list explains the available URI protocols. URI
  5529. protocols are highly dependent on particular BitBake Fetcher
  5530. submodules. Depending on the fetcher BitBake uses, various URL
  5531. parameters are employed. For specifics on the supported Fetchers, see
  5532. the ":ref:`Fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`" section in the
  5533. BitBake User Manual.
  5534. - ``file://`` - Fetches files, which are usually files shipped
  5535. with the :term:`Metadata`, from the local machine (e.g.
  5536. :ref:`patch <overview-manual/concepts:patching>` files).
  5537. The path is relative to the :term:`FILESPATH`
  5538. variable. Thus, the build system searches, in order, from the
  5539. following directories, which are assumed to be a subdirectories of
  5540. the directory in which the recipe file (``.bb``) or append file
  5541. (``.bbappend``) resides:
  5542. - ``${BPN}`` - The base recipe name without any special suffix
  5543. or version numbers.
  5544. - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and
  5545. version but without any special package name suffix.
  5546. - *files -* Files within a directory, which is named ``files``
  5547. and is also alongside the recipe or append file.
  5548. .. note::
  5549. If you want the build system to pick up files specified through
  5550. a
  5551. SRC_URI
  5552. statement from your append file, you need to be sure to extend
  5553. the
  5554. FILESPATH
  5555. variable by also using the
  5556. FILESEXTRAPATHS
  5557. variable from within your append file.
  5558. - ``bzr://`` - Fetches files from a Bazaar revision control
  5559. repository.
  5560. - ``git://`` - Fetches files from a Git revision control
  5561. repository.
  5562. - ``osc://`` - Fetches files from an OSC (OpenSUSE Build service)
  5563. revision control repository.
  5564. - ``repo://`` - Fetches files from a repo (Git) repository.
  5565. - ``ccrc://`` - Fetches files from a ClearCase repository.
  5566. - ``http://`` - Fetches files from the Internet using ``http``.
  5567. - ``https://`` - Fetches files from the Internet using ``https``.
  5568. - ``ftp://`` - Fetches files from the Internet using ``ftp``.
  5569. - ``cvs://`` - Fetches files from a CVS revision control
  5570. repository.
  5571. - ``hg://`` - Fetches files from a Mercurial (``hg``) revision
  5572. control repository.
  5573. - ``p4://`` - Fetches files from a Perforce (``p4``) revision
  5574. control repository.
  5575. - ``ssh://`` - Fetches files from a secure shell.
  5576. - ``svn://`` - Fetches files from a Subversion (``svn``) revision
  5577. control repository.
  5578. - ``npm://`` - Fetches JavaScript modules from a registry.
  5579. Standard and recipe-specific options for ``SRC_URI`` exist. Here are
  5580. standard options:
  5581. - ``apply`` - Whether to apply the patch or not. The default
  5582. action is to apply the patch.
  5583. - ``striplevel`` - Which striplevel to use when applying the
  5584. patch. The default level is 1.
  5585. - ``patchdir`` - Specifies the directory in which the patch should
  5586. be applied. The default is ``${``\ :term:`S`\ ``}``.
  5587. Here are options specific to recipes building code from a revision
  5588. control system:
  5589. - ``mindate`` - Apply the patch only if
  5590. :term:`SRCDATE` is equal to or greater than
  5591. ``mindate``.
  5592. - ``maxdate`` - Apply the patch only if ``SRCDATE`` is not later
  5593. than ``maxdate``.
  5594. - ``minrev`` - Apply the patch only if ``SRCREV`` is equal to or
  5595. greater than ``minrev``.
  5596. - ``maxrev`` - Apply the patch only if ``SRCREV`` is not later
  5597. than ``maxrev``.
  5598. - ``rev`` - Apply the patch only if ``SRCREV`` is equal to
  5599. ``rev``.
  5600. - ``notrev`` - Apply the patch only if ``SRCREV`` is not equal to
  5601. ``rev``.
  5602. Here are some additional options worth mentioning:
  5603. - ``unpack`` - Controls whether or not to unpack the file if it is
  5604. an archive. The default action is to unpack the file.
  5605. - ``destsuffix`` - Places the file (or extracts its contents) into
  5606. the specified subdirectory of :term:`WORKDIR` when
  5607. the Git fetcher is used.
  5608. - ``subdir`` - Places the file (or extracts its contents) into the
  5609. specified subdirectory of ``WORKDIR`` when the local (``file://``)
  5610. fetcher is used.
  5611. - ``localdir`` - Places the file (or extracts its contents) into
  5612. the specified subdirectory of ``WORKDIR`` when the CVS fetcher is
  5613. used.
  5614. - ``subpath`` - Limits the checkout to a specific subpath of the
  5615. tree when using the Git fetcher is used.
  5616. - ``name`` - Specifies a name to be used for association with
  5617. ``SRC_URI`` checksums or :term:`SRCREV` when you have more than one
  5618. file or git repository specified in ``SRC_URI``. For example:
  5619. ::
  5620. SRC_URI = "git://example.com/foo.git;name=first \
  5621. git://example.com/bar.git;name=second \
  5622. http://example.com/file.tar.gz;name=third"
  5623. SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
  5624. SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f"
  5625. SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
  5626. - ``downloadfilename`` - Specifies the filename used when storing
  5627. the downloaded file.
  5628. :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
  5629. By default, the OpenEmbedded build system automatically detects
  5630. whether ``SRC_URI`` contains files that are machine-specific. If so,
  5631. the build system automatically changes ``PACKAGE_ARCH``. Setting this
  5632. variable to "0" disables this behavior.
  5633. :term:`SRCDATE`
  5634. The date of the source code used to build the package. This variable
  5635. applies only if the source was fetched from a Source Code Manager
  5636. (SCM).
  5637. :term:`SRCPV`
  5638. Returns the version string of the current package. This string is
  5639. used to help define the value of :term:`PV`.
  5640. The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf``
  5641. configuration file in the :term:`Source Directory` as
  5642. follows:
  5643. ::
  5644. SRCPV = "${@bb.fetch2.get_srcrev(d)}"
  5645. Recipes that need to define ``PV`` do so with the help of the
  5646. ``SRCPV``. For example, the ``ofono`` recipe (``ofono_git.bb``)
  5647. located in ``meta/recipes-connectivity`` in the Source Directory
  5648. defines ``PV`` as follows:
  5649. ::
  5650. PV = "0.12-git${SRCPV}"
  5651. :term:`SRCREV`
  5652. The revision of the source code used to build the package. This
  5653. variable applies to Subversion, Git, Mercurial, and Bazaar only. Note
  5654. that if you want to build a fixed revision and you want to avoid
  5655. performing a query on the remote repository every time BitBake parses
  5656. your recipe, you should specify a ``SRCREV`` that is a full revision
  5657. identifier and not just a tag.
  5658. .. note::
  5659. For information on limitations when inheriting the latest revision
  5660. of software using ``SRCREV``, see the :term:`AUTOREV` variable
  5661. description and the
  5662. ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
  5663. section, which is in the Yocto Project Development Tasks Manual.
  5664. :term:`SSTATE_DIR`
  5665. The directory for the shared state cache.
  5666. :term:`SSTATE_MIRROR_ALLOW_NETWORK`
  5667. If set to "1", allows fetches from mirrors that are specified in
  5668. :term:`SSTATE_MIRRORS` to work even when
  5669. fetching from the network is disabled by setting ``BB_NO_NETWORK`` to
  5670. "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if
  5671. you have set ``SSTATE_MIRRORS`` to point to an internal server for
  5672. your shared state cache, but you want to disable any other fetching
  5673. from the network.
  5674. :term:`SSTATE_MIRRORS`
  5675. Configures the OpenEmbedded build system to search other mirror
  5676. locations for prebuilt cache data objects before building out the
  5677. data. This variable works like fetcher :term:`MIRRORS`
  5678. and :term:`PREMIRRORS` and points to the cache
  5679. locations to check for the shared state (sstate) objects.
  5680. You can specify a filesystem directory or a remote URL such as HTTP
  5681. or FTP. The locations you specify need to contain the shared state
  5682. cache (sstate-cache) results from previous builds. The sstate-cache
  5683. you point to can also be from builds on other machines.
  5684. When pointing to sstate build artifacts on another machine that uses
  5685. a different GCC version for native builds, you must configure
  5686. ``SSTATE_MIRRORS`` with a regular expression that maps local search
  5687. paths to server paths. The paths need to take into account
  5688. :term:`NATIVELSBSTRING` set by the
  5689. :ref:`uninative <ref-classes-uninative>` class. For example, the
  5690. following maps the local search path ``universal-4.9`` to the
  5691. server-provided path server_url_sstate_path:
  5692. ::
  5693. SSTATE_MIRRORS ?= "file://universal-4.9/(.*) http://server_url_sstate_path/universal-4.8/\1 \n"
  5694. If a mirror uses the same structure as
  5695. :term:`SSTATE_DIR`, you need to add "PATH" at the
  5696. end as shown in the examples below. The build system substitutes the
  5697. correct path within the directory structure.
  5698. ::
  5699. SSTATE_MIRRORS ?= "\
  5700. file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
  5701. file://.* file:///some-local-dir/sstate/PATH"
  5702. :term:`SSTATE_SCAN_FILES`
  5703. Controls the list of files the OpenEmbedded build system scans for
  5704. hardcoded installation paths. The variable uses a space-separated
  5705. list of filenames (not paths) with standard wildcard characters
  5706. allowed.
  5707. During a build, the OpenEmbedded build system creates a shared state
  5708. (sstate) object during the first stage of preparing the sysroots.
  5709. That object is scanned for hardcoded paths for original installation
  5710. locations. The list of files that are scanned for paths is controlled
  5711. by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files
  5712. they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather
  5713. than the variable being comprehensively set. The
  5714. :ref:`sstate <ref-classes-sstate>` class specifies the default list
  5715. of files.
  5716. For details on the process, see the
  5717. :ref:`staging <ref-classes-staging>` class.
  5718. :term:`STAGING_BASE_LIBDIR_NATIVE`
  5719. Specifies the path to the ``/lib`` subdirectory of the sysroot
  5720. directory for the build host.
  5721. :term:`STAGING_BASELIBDIR`
  5722. Specifies the path to the ``/lib`` subdirectory of the sysroot
  5723. directory for the target for which the current recipe is being built
  5724. (:term:`STAGING_DIR_HOST`).
  5725. :term:`STAGING_BINDIR`
  5726. Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
  5727. directory for the target for which the current recipe is being built
  5728. (:term:`STAGING_DIR_HOST`).
  5729. :term:`STAGING_BINDIR_CROSS`
  5730. Specifies the path to the directory containing binary configuration
  5731. scripts. These scripts provide configuration information for other
  5732. software that wants to make use of libraries or include files
  5733. provided by the software associated with the script.
  5734. .. note::
  5735. This style of build configuration has been largely replaced by
  5736. ``pkg-config``. Consequently, if ``pkg-config`` is supported by the
  5737. library to which you are linking, it is recommended you use
  5738. ``pkg-config`` instead of a provided configuration script.
  5739. :term:`STAGING_BINDIR_NATIVE`
  5740. Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
  5741. directory for the build host.
  5742. :term:`STAGING_DATADIR`
  5743. Specifies the path to the ``/usr/share`` subdirectory of the sysroot
  5744. directory for the target for which the current recipe is being built
  5745. (:term:`STAGING_DIR_HOST`).
  5746. :term:`STAGING_DATADIR_NATIVE`
  5747. Specifies the path to the ``/usr/share`` subdirectory of the sysroot
  5748. directory for the build host.
  5749. :term:`STAGING_DIR`
  5750. Helps construct the ``recipe-sysroots`` directory, which is used
  5751. during packaging.
  5752. For information on how staging for recipe-specific sysroots occurs,
  5753. see the :ref:`ref-tasks-populate_sysroot`
  5754. task, the ":ref:`sdk-manual/extensible:sharing files between recipes`"
  5755. section in the Yocto Project Development Tasks Manual, the
  5756. ":ref:`overview-manual/concepts:configuration, compilation, and staging`"
  5757. section in the Yocto Project Overview and Concepts Manual, and the
  5758. :term:`SYSROOT_DIRS` variable.
  5759. .. note::
  5760. Recipes should never write files directly under the ``STAGING_DIR``
  5761. directory because the OpenEmbedded build system manages the
  5762. directory automatically. Instead, files should be installed to
  5763. ``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install`
  5764. task and then the OpenEmbedded build system will stage a subset of
  5765. those files into the sysroot.
  5766. :term:`STAGING_DIR_HOST`
  5767. Specifies the path to the sysroot directory for the system on which
  5768. the component is built to run (the system that hosts the component).
  5769. For most recipes, this sysroot is the one in which that recipe's
  5770. :ref:`ref-tasks-populate_sysroot` task copies
  5771. files. Exceptions include ``-native`` recipes, where the
  5772. ``do_populate_sysroot`` task instead uses
  5773. :term:`STAGING_DIR_NATIVE`. Depending on
  5774. the type of recipe and the build target, ``STAGING_DIR_HOST`` can
  5775. have the following values:
  5776. - For recipes building for the target machine, the value is
  5777. "${:term:`STAGING_DIR`}/${:term:`MACHINE`}".
  5778. - For native recipes building for the build host, the value is empty
  5779. given the assumption that when building for the build host, the
  5780. build host's own directories should be used.
  5781. .. note::
  5782. ``-native`` recipes are not installed into host paths like such
  5783. as ``/usr``. Rather, these recipes are installed into
  5784. ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes,
  5785. standard build environment variables such as
  5786. :term:`CPPFLAGS` and
  5787. :term:`CFLAGS` are set up so that both host paths
  5788. and ``STAGING_DIR_NATIVE`` are searched for libraries and
  5789. headers using, for example, GCC's ``-isystem`` option.
  5790. Thus, the emphasis is that the ``STAGING_DIR*`` variables
  5791. should be viewed as input variables by tasks such as
  5792. :ref:`ref-tasks-configure`,
  5793. :ref:`ref-tasks-compile`, and
  5794. :ref:`ref-tasks-install`. Having the real system
  5795. root correspond to ``STAGING_DIR_HOST`` makes conceptual sense
  5796. for ``-native`` recipes, as they make use of host headers and
  5797. libraries.
  5798. :term:`STAGING_DIR_NATIVE`
  5799. Specifies the path to the sysroot directory used when building
  5800. components that run on the build host itself.
  5801. :term:`STAGING_DIR_TARGET`
  5802. Specifies the path to the sysroot used for the system for which the
  5803. component generates code. For components that do not generate code,
  5804. which is the majority, ``STAGING_DIR_TARGET`` is set to match
  5805. :term:`STAGING_DIR_HOST`.
  5806. Some recipes build binaries that can run on the target system but
  5807. those binaries in turn generate code for another different system
  5808. (e.g. cross-canadian recipes). Using terminology from GNU, the
  5809. primary system is referred to as the "HOST" and the secondary, or
  5810. different, system is referred to as the "TARGET". Thus, the binaries
  5811. run on the "HOST" system and generate binaries for the "TARGET"
  5812. system. The ``STAGING_DIR_HOST`` variable points to the sysroot used
  5813. for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the
  5814. sysroot used for the "TARGET" system.
  5815. :term:`STAGING_ETCDIR_NATIVE`
  5816. Specifies the path to the ``/etc`` subdirectory of the sysroot
  5817. directory for the build host.
  5818. :term:`STAGING_EXECPREFIXDIR`
  5819. Specifies the path to the ``/usr`` subdirectory of the sysroot
  5820. directory for the target for which the current recipe is being built
  5821. (:term:`STAGING_DIR_HOST`).
  5822. :term:`STAGING_INCDIR`
  5823. Specifies the path to the ``/usr/include`` subdirectory of the
  5824. sysroot directory for the target for which the current recipe being
  5825. built (:term:`STAGING_DIR_HOST`).
  5826. :term:`STAGING_INCDIR_NATIVE`
  5827. Specifies the path to the ``/usr/include`` subdirectory of the
  5828. sysroot directory for the build host.
  5829. :term:`STAGING_KERNEL_BUILDDIR`
  5830. Points to the directory containing the kernel build artifacts.
  5831. Recipes building software that needs to access kernel build artifacts
  5832. (e.g. ``systemtap-uprobes``) can look in the directory specified with
  5833. the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts
  5834. after the kernel has been built.
  5835. :term:`STAGING_KERNEL_DIR`
  5836. The directory with kernel headers that are required to build
  5837. out-of-tree modules.
  5838. :term:`STAGING_LIBDIR`
  5839. Specifies the path to the ``/usr/lib`` subdirectory of the sysroot
  5840. directory for the target for which the current recipe is being built
  5841. (:term:`STAGING_DIR_HOST`).
  5842. :term:`STAGING_LIBDIR_NATIVE`
  5843. Specifies the path to the ``/usr/lib`` subdirectory of the sysroot
  5844. directory for the build host.
  5845. :term:`STAMP`
  5846. Specifies the base path used to create recipe stamp files. The path
  5847. to an actual stamp file is constructed by evaluating this string and
  5848. then appending additional information. Currently, the default
  5849. assignment for ``STAMP`` as set in the ``meta/conf/bitbake.conf``
  5850. file is:
  5851. ::
  5852. STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}"
  5853. For information on how BitBake uses stamp files to determine if a
  5854. task should be rerun, see the
  5855. ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`"
  5856. section in the Yocto Project Overview and Concepts Manual.
  5857. See :term:`STAMPS_DIR`,
  5858. :term:`MULTIMACH_TARGET_SYS`,
  5859. :term:`PN`, :term:`EXTENDPE`,
  5860. :term:`PV`, and :term:`PR` for related variable
  5861. information.
  5862. :term:`STAMPS_DIR`
  5863. Specifies the base directory in which the OpenEmbedded build system
  5864. places stamps. The default directory is ``${TMPDIR}/stamps``.
  5865. :term:`STRIP`
  5866. The minimal command and arguments to run ``strip``, which is used to
  5867. strip symbols.
  5868. :term:`SUMMARY`
  5869. The short (72 characters or less) summary of the binary package for
  5870. packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default,
  5871. ``SUMMARY`` is used to define the
  5872. :term:`DESCRIPTION` variable if ``DESCRIPTION`` is
  5873. not set in the recipe.
  5874. :term:`SVNDIR`
  5875. The directory in which files checked out of a Subversion system are
  5876. stored.
  5877. :term:`SYSLINUX_DEFAULT_CONSOLE`
  5878. Specifies the kernel boot default console. If you want to use a
  5879. console other than the default, set this variable in your recipe as
  5880. follows where "X" is the console number you want to use:
  5881. ::
  5882. SYSLINUX_DEFAULT_CONSOLE = "console=ttyX"
  5883. The :ref:`syslinux <ref-classes-syslinux>` class initially sets
  5884. this variable to null but then checks for a value later.
  5885. :term:`SYSLINUX_OPTS`
  5886. Lists additional options to add to the syslinux file. You need to set
  5887. this variable in your recipe. If you want to list multiple options,
  5888. separate the options with a semicolon character (``;``).
  5889. The :ref:`syslinux <ref-classes-syslinux>` class uses this variable
  5890. to create a set of options.
  5891. :term:`SYSLINUX_SERIAL`
  5892. Specifies the alternate serial port or turns it off. To turn off
  5893. serial, set this variable to an empty string in your recipe. The
  5894. variable's default value is set in the
  5895. :ref:`syslinux <ref-classes-syslinux>` class as follows:
  5896. ::
  5897. SYSLINUX_SERIAL ?= "0 115200"
  5898. The class checks for and uses the variable as needed.
  5899. :term:`SYSLINUX_SERIAL_TTY`
  5900. Specifies the alternate console=tty... kernel boot argument. The
  5901. variable's default value is set in the
  5902. :ref:`syslinux <ref-classes-syslinux>` class as follows:
  5903. ::
  5904. SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200"
  5905. The class checks for and uses the variable as needed.
  5906. :term:`SYSLINUX_SPLASH`
  5907. An ``.LSS`` file used as the background for the VGA boot menu when
  5908. you use the boot menu. You need to set this variable in your recipe.
  5909. The :ref:`syslinux <ref-classes-syslinux>` class checks for this
  5910. variable and if found, the OpenEmbedded build system installs the
  5911. splash screen.
  5912. :term:`SYSROOT_DESTDIR`
  5913. Points to the temporary directory under the work directory (default
  5914. "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``")
  5915. where the files populated into the sysroot are assembled during the
  5916. :ref:`ref-tasks-populate_sysroot` task.
  5917. :term:`SYSROOT_DIRS`
  5918. Directories that are staged into the sysroot by the
  5919. :ref:`ref-tasks-populate_sysroot` task. By
  5920. default, the following directories are staged:
  5921. ::
  5922. SYSROOT_DIRS = " \
  5923. ${includedir} \
  5924. ${libdir} \
  5925. ${base_libdir} \
  5926. ${nonarch_base_libdir} \
  5927. ${datadir} \
  5928. "
  5929. :term:`SYSROOT_DIRS_BLACKLIST`
  5930. Directories that are not staged into the sysroot by the
  5931. :ref:`ref-tasks-populate_sysroot` task. You
  5932. can use this variable to exclude certain subdirectories of
  5933. directories listed in :term:`SYSROOT_DIRS` from
  5934. staging. By default, the following directories are not staged:
  5935. ::
  5936. SYSROOT_DIRS_BLACKLIST = " \
  5937. ${mandir} \
  5938. ${docdir} \
  5939. ${infodir} \
  5940. ${datadir}/locale \
  5941. ${datadir}/applications \
  5942. ${datadir}/fonts \
  5943. ${datadir}/pixmaps \
  5944. "
  5945. :term:`SYSROOT_DIRS_NATIVE`
  5946. Extra directories staged into the sysroot by the
  5947. :ref:`ref-tasks-populate_sysroot` task for
  5948. ``-native`` recipes, in addition to those specified in
  5949. :term:`SYSROOT_DIRS`. By default, the following
  5950. extra directories are staged:
  5951. ::
  5952. SYSROOT_DIRS_NATIVE = " \
  5953. ${bindir} \
  5954. ${sbindir} \
  5955. ${base_bindir} \
  5956. ${base_sbindir} \
  5957. ${libexecdir} \
  5958. ${sysconfdir} \
  5959. ${localstatedir} \
  5960. "
  5961. .. note::
  5962. Programs built by ``-native`` recipes run directly from the sysroot
  5963. (:term:`STAGING_DIR_NATIVE`), which is why additional directories
  5964. containing program executables and supporting files need to be staged.
  5965. :term:`SYSROOT_PREPROCESS_FUNCS`
  5966. A list of functions to execute after files are staged into the
  5967. sysroot. These functions are usually used to apply additional
  5968. processing on the staged files, or to stage additional files.
  5969. :term:`SYSTEMD_AUTO_ENABLE`
  5970. When inheriting the :ref:`systemd <ref-classes-systemd>` class,
  5971. this variable specifies whether the specified service in
  5972. :term:`SYSTEMD_SERVICE` should start
  5973. automatically or not. By default, the service is enabled to
  5974. automatically start at boot time. The default setting is in the
  5975. :ref:`systemd <ref-classes-systemd>` class as follows:
  5976. ::
  5977. SYSTEMD_AUTO_ENABLE ??= "enable"
  5978. You can disable the service by setting the variable to "disable".
  5979. :term:`SYSTEMD_BOOT_CFG`
  5980. When :term:`EFI_PROVIDER` is set to
  5981. "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the
  5982. configuration file that should be used. By default, the
  5983. :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the
  5984. ``SYSTEMD_BOOT_CFG`` as follows:
  5985. ::
  5986. SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf"
  5987. For information on Systemd-boot, see the `Systemd-boot
  5988. documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
  5989. :term:`SYSTEMD_BOOT_ENTRIES`
  5990. When :term:`EFI_PROVIDER` is set to
  5991. "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a
  5992. list of entry files (``*.conf``) to install that contain one boot
  5993. entry per file. By default, the
  5994. :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the
  5995. ``SYSTEMD_BOOT_ENTRIES`` as follows:
  5996. ::
  5997. SYSTEMD_BOOT_ENTRIES ?= ""
  5998. For information on Systemd-boot, see the `Systemd-boot
  5999. documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
  6000. :term:`SYSTEMD_BOOT_TIMEOUT`
  6001. When :term:`EFI_PROVIDER` is set to
  6002. "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the
  6003. boot menu timeout in seconds. By default, the
  6004. :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the
  6005. ``SYSTEMD_BOOT_TIMEOUT`` as follows:
  6006. ::
  6007. SYSTEMD_BOOT_TIMEOUT ?= "10"
  6008. For information on Systemd-boot, see the `Systemd-boot
  6009. documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
  6010. :term:`SYSTEMD_PACKAGES`
  6011. When inheriting the :ref:`systemd <ref-classes-systemd>` class,
  6012. this variable locates the systemd unit files when they are not found
  6013. in the main recipe's package. By default, the ``SYSTEMD_PACKAGES``
  6014. variable is set such that the systemd unit files are assumed to
  6015. reside in the recipes main package:
  6016. ::
  6017. SYSTEMD_PACKAGES ?= "${PN}"
  6018. If these unit files are not in this recipe's main package, you need
  6019. to use ``SYSTEMD_PACKAGES`` to list the package or packages in which
  6020. the build system can find the systemd unit files.
  6021. :term:`SYSTEMD_SERVICE`
  6022. When inheriting the :ref:`systemd <ref-classes-systemd>` class,
  6023. this variable specifies the systemd service name for a package.
  6024. When you specify this file in your recipe, use a package name
  6025. override to indicate the package to which the value applies. Here is
  6026. an example from the connman recipe:
  6027. ::
  6028. SYSTEMD_SERVICE_${PN} = "connman.service"
  6029. :term:`SYSVINIT_ENABLED_GETTYS`
  6030. When using
  6031. :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`,
  6032. specifies a space-separated list of the virtual terminals that should
  6033. run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__
  6034. (allowing login), assuming :term:`USE_VT` is not set to
  6035. "0".
  6036. The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only
  6037. run a getty on the first virtual terminal).
  6038. :term:`T`
  6039. This variable points to a directory were BitBake places temporary
  6040. files, which consist mostly of task logs and scripts, when building a
  6041. particular recipe. The variable is typically set as follows:
  6042. ::
  6043. T = "${WORKDIR}/temp"
  6044. The :term:`WORKDIR` is the directory into which
  6045. BitBake unpacks and builds the recipe. The default ``bitbake.conf``
  6046. file sets this variable.
  6047. The ``T`` variable is not to be confused with the
  6048. :term:`TMPDIR` variable, which points to the root of
  6049. the directory tree where BitBake places the output of an entire
  6050. build.
  6051. :term:`TARGET_ARCH`
  6052. The target machine's architecture. The OpenEmbedded build system
  6053. supports many architectures. Here is an example list of architectures
  6054. supported. This list is by no means complete as the architecture is
  6055. configurable:
  6056. - arm
  6057. - i586
  6058. - x86_64
  6059. - powerpc
  6060. - powerpc64
  6061. - mips
  6062. - mipsel
  6063. For additional information on machine architectures, see the
  6064. :term:`TUNE_ARCH` variable.
  6065. :term:`TARGET_AS_ARCH`
  6066. Specifies architecture-specific assembler flags for the target
  6067. system. ``TARGET_AS_ARCH`` is initialized from
  6068. :term:`TUNE_ASARGS` by default in the BitBake
  6069. configuration file (``meta/conf/bitbake.conf``):
  6070. ::
  6071. TARGET_AS_ARCH = "${TUNE_ASARGS}"
  6072. :term:`TARGET_CC_ARCH`
  6073. Specifies architecture-specific C compiler flags for the target
  6074. system. ``TARGET_CC_ARCH`` is initialized from
  6075. :term:`TUNE_CCARGS` by default.
  6076. .. note::
  6077. It is a common workaround to append :term:`LDFLAGS` to
  6078. ``TARGET_CC_ARCH`` in recipes that build software for the target that
  6079. would not otherwise respect the exported ``LDFLAGS`` variable.
  6080. :term:`TARGET_CC_KERNEL_ARCH`
  6081. This is a specific kernel compiler flag for a CPU or Application
  6082. Binary Interface (ABI) tune. The flag is used rarely and only for
  6083. cases where a userspace :term:`TUNE_CCARGS` is not
  6084. compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH``
  6085. variable allows the kernel (and associated modules) to use a
  6086. different configuration. See the
  6087. ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the
  6088. :term:`Source Directory` for an example.
  6089. :term:`TARGET_CFLAGS`
  6090. Specifies the flags to pass to the C compiler when building for the
  6091. target. When building in the target context,
  6092. :term:`CFLAGS` is set to the value of this variable by
  6093. default.
  6094. Additionally, the SDK's environment setup script sets the ``CFLAGS``
  6095. variable in the environment to the ``TARGET_CFLAGS`` value so that
  6096. executables built using the SDK also have the flags applied.
  6097. :term:`TARGET_CPPFLAGS`
  6098. Specifies the flags to pass to the C pre-processor (i.e. to both the
  6099. C and the C++ compilers) when building for the target. When building
  6100. in the target context, :term:`CPPFLAGS` is set to the
  6101. value of this variable by default.
  6102. Additionally, the SDK's environment setup script sets the
  6103. ``CPPFLAGS`` variable in the environment to the ``TARGET_CPPFLAGS``
  6104. value so that executables built using the SDK also have the flags
  6105. applied.
  6106. :term:`TARGET_CXXFLAGS`
  6107. Specifies the flags to pass to the C++ compiler when building for the
  6108. target. When building in the target context,
  6109. :term:`CXXFLAGS` is set to the value of this variable
  6110. by default.
  6111. Additionally, the SDK's environment setup script sets the
  6112. ``CXXFLAGS`` variable in the environment to the ``TARGET_CXXFLAGS``
  6113. value so that executables built using the SDK also have the flags
  6114. applied.
  6115. :term:`TARGET_FPU`
  6116. Specifies the method for handling FPU code. For FPU-less targets,
  6117. which include most ARM CPUs, the variable must be set to "soft". If
  6118. not, the kernel emulation gets used, which results in a performance
  6119. penalty.
  6120. :term:`TARGET_LD_ARCH`
  6121. Specifies architecture-specific linker flags for the target system.
  6122. ``TARGET_LD_ARCH`` is initialized from
  6123. :term:`TUNE_LDARGS` by default in the BitBake
  6124. configuration file (``meta/conf/bitbake.conf``):
  6125. ::
  6126. TARGET_LD_ARCH = "${TUNE_LDARGS}"
  6127. :term:`TARGET_LDFLAGS`
  6128. Specifies the flags to pass to the linker when building for the
  6129. target. When building in the target context,
  6130. :term:`LDFLAGS` is set to the value of this variable
  6131. by default.
  6132. Additionally, the SDK's environment setup script sets the
  6133. :term:`LDFLAGS` variable in the environment to the
  6134. ``TARGET_LDFLAGS`` value so that executables built using the SDK also
  6135. have the flags applied.
  6136. :term:`TARGET_OS`
  6137. Specifies the target's operating system. The variable can be set to
  6138. "linux" for glibc-based systems (GNU C Library) and to "linux-musl"
  6139. for musl libc. For ARM/EABI targets, "linux-gnueabi" and
  6140. "linux-musleabi" possible values exist.
  6141. :term:`TARGET_PREFIX`
  6142. Specifies the prefix used for the toolchain binary target tools.
  6143. Depending on the type of recipe and the build target,
  6144. ``TARGET_PREFIX`` is set as follows:
  6145. - For recipes building for the target machine, the value is
  6146. "${:term:`TARGET_SYS`}-".
  6147. - For native recipes, the build system sets the variable to the
  6148. value of ``BUILD_PREFIX``.
  6149. - For native SDK recipes (``nativesdk``), the build system sets the
  6150. variable to the value of ``SDK_PREFIX``.
  6151. :term:`TARGET_SYS`
  6152. Specifies the system, including the architecture and the operating
  6153. system, for which the build is occurring in the context of the
  6154. current recipe.
  6155. The OpenEmbedded build system automatically sets this variable based
  6156. on :term:`TARGET_ARCH`,
  6157. :term:`TARGET_VENDOR`, and
  6158. :term:`TARGET_OS` variables.
  6159. .. note::
  6160. You do not need to set the ``TARGET_SYS`` variable yourself.
  6161. Consider these two examples:
  6162. - Given a native recipe on a 32-bit, x86 machine running Linux, the
  6163. value is "i686-linux".
  6164. - Given a recipe being built for a little-endian, MIPS target
  6165. running Linux, the value might be "mipsel-linux".
  6166. :term:`TARGET_VENDOR`
  6167. Specifies the name of the target vendor.
  6168. :term:`TCLIBC`
  6169. Specifies the GNU standard C library (``libc``) variant to use during
  6170. the build process. This variable replaces ``POKYLIBC``, which is no
  6171. longer supported.
  6172. You can select "glibc", "musl", "newlib", or "baremetal"
  6173. :term:`TCLIBCAPPEND`
  6174. Specifies a suffix to be appended onto the
  6175. :term:`TMPDIR` value. The suffix identifies the
  6176. ``libc`` variant for building. When you are building for multiple
  6177. variants with the same :term:`Build Directory`, this
  6178. mechanism ensures that output for different ``libc`` variants is kept
  6179. separate to avoid potential conflicts.
  6180. In the ``defaultsetup.conf`` file, the default value of
  6181. ``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky,
  6182. which normally only support one ``libc`` variant, set
  6183. ``TCLIBCAPPEND`` to "" in their distro configuration file resulting
  6184. in no suffix being applied.
  6185. :term:`TCMODE`
  6186. Specifies the toolchain selector. ``TCMODE`` controls the
  6187. characteristics of the generated packages and images by telling the
  6188. OpenEmbedded build system which toolchain profile to use. By default,
  6189. the OpenEmbedded build system builds its own internal toolchain. The
  6190. variable's default value is "default", which uses that internal
  6191. toolchain.
  6192. .. note::
  6193. If ``TCMODE`` is set to a value other than "default", then it is your
  6194. responsibility to ensure that the toolchain is compatible with the
  6195. default toolchain. Using older or newer versions of these
  6196. components might cause build problems. See the Release Notes for
  6197. the Yocto Project release for the specific components with which
  6198. the toolchain must be compatible. To access the Release Notes, go
  6199. to the :yocto_home:`Downloads </software-overview/downloads>`
  6200. page on the Yocto Project website and click on the "RELEASE
  6201. INFORMATION" link for the appropriate release.
  6202. The ``TCMODE`` variable is similar to :term:`TCLIBC`,
  6203. which controls the variant of the GNU standard C library (``libc``)
  6204. used during the build process: ``glibc`` or ``musl``.
  6205. With additional layers, it is possible to use a pre-compiled external
  6206. toolchain. One example is the Sourcery G++ Toolchain. The support for
  6207. this toolchain resides in the separate Mentor Graphics
  6208. ``meta-sourcery`` layer at
  6209. https://github.com/MentorEmbedded/meta-sourcery/.
  6210. The layer's ``README`` file contains information on how to use the
  6211. Sourcery G++ Toolchain as an external toolchain. In summary, you must
  6212. be sure to add the layer to your ``bblayers.conf`` file in front of
  6213. the ``meta`` layer and then set the ``EXTERNAL_TOOLCHAIN`` variable
  6214. in your ``local.conf`` file to the location in which you installed
  6215. the toolchain.
  6216. The fundamentals used for this example apply to any external
  6217. toolchain. You can use ``meta-sourcery`` as a template for adding
  6218. support for other external toolchains.
  6219. :term:`TEST_EXPORT_DIR`
  6220. The location the OpenEmbedded build system uses to export tests when
  6221. the :term:`TEST_EXPORT_ONLY` variable is set
  6222. to "1".
  6223. The ``TEST_EXPORT_DIR`` variable defaults to
  6224. ``"${TMPDIR}/testimage/${PN}"``.
  6225. :term:`TEST_EXPORT_ONLY`
  6226. Specifies to export the tests only. Set this variable to "1" if you
  6227. do not want to run the tests but you want them to be exported in a
  6228. manner that you to run them outside of the build system.
  6229. :term:`TEST_LOG_DIR`
  6230. Holds the SSH log and the boot log for QEMU machines. The
  6231. ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``.
  6232. .. note::
  6233. Actual test results reside in the task log (``log.do_testimage``),
  6234. which is in the ``${WORKDIR}/temp/`` directory.
  6235. :term:`TEST_POWERCONTROL_CMD`
  6236. For automated hardware testing, specifies the command to use to
  6237. control the power of the target machine under test. Typically, this
  6238. command would point to a script that performs the appropriate action
  6239. (e.g. interacting with a web-enabled power strip). The specified
  6240. command should expect to receive as the last argument "off", "on" or
  6241. "cycle" specifying to power off, on, or cycle (power off and then
  6242. power on) the device, respectively.
  6243. :term:`TEST_POWERCONTROL_EXTRA_ARGS`
  6244. For automated hardware testing, specifies additional arguments to
  6245. pass through to the command specified in
  6246. :term:`TEST_POWERCONTROL_CMD`. Setting
  6247. ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you
  6248. wish, for example, to separate the machine-specific and
  6249. non-machine-specific parts of the arguments.
  6250. :term:`TEST_QEMUBOOT_TIMEOUT`
  6251. The time in seconds allowed for an image to boot before automated
  6252. runtime tests begin to run against an image. The default timeout
  6253. period to allow the boot process to reach the login prompt is 500
  6254. seconds. You can specify a different value in the ``local.conf``
  6255. file.
  6256. For more information on testing images, see the
  6257. ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
  6258. section in the Yocto Project Development Tasks Manual.
  6259. :term:`TEST_SERIALCONTROL_CMD`
  6260. For automated hardware testing, specifies the command to use to
  6261. connect to the serial console of the target machine under test. This
  6262. command simply needs to connect to the serial console and forward
  6263. that connection to standard input and output as any normal terminal
  6264. program does.
  6265. For example, to use the Picocom terminal program on serial device
  6266. ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows:
  6267. ::
  6268. TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200"
  6269. :term:`TEST_SERIALCONTROL_EXTRA_ARGS`
  6270. For automated hardware testing, specifies additional arguments to
  6271. pass through to the command specified in
  6272. :term:`TEST_SERIALCONTROL_CMD`. Setting
  6273. ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you
  6274. wish, for example, to separate the machine-specific and
  6275. non-machine-specific parts of the command.
  6276. :term:`TEST_SERVER_IP`
  6277. The IP address of the build machine (host machine). This IP address
  6278. is usually automatically detected. However, if detection fails, this
  6279. variable needs to be set to the IP address of the build machine (i.e.
  6280. where the build is taking place).
  6281. .. note::
  6282. The ``TEST_SERVER_IP`` variable is only used for a small number of
  6283. tests such as the "dnf" test suite, which needs to download packages
  6284. from ``WORKDIR/oe-rootfs-repo``.
  6285. :term:`TEST_SUITES`
  6286. An ordered list of tests (modules) to run against an image when
  6287. performing automated runtime testing.
  6288. The OpenEmbedded build system provides a core set of tests that can
  6289. be used against images.
  6290. .. note::
  6291. Currently, there is only support for running these tests under
  6292. QEMU.
  6293. Tests include ``ping``, ``ssh``, ``df`` among others. You can add
  6294. your own tests to the list of tests by appending ``TEST_SUITES`` as
  6295. follows:
  6296. ::
  6297. TEST_SUITES_append = " mytest"
  6298. Alternatively, you can
  6299. provide the "auto" option to have all applicable tests run against
  6300. the image.
  6301. ::
  6302. TEST_SUITES_append = " auto"
  6303. Using this option causes the
  6304. build system to automatically run tests that are applicable to the
  6305. image. Tests that are not applicable are skipped.
  6306. The order in which tests are run is important. Tests that depend on
  6307. another test must appear later in the list than the test on which
  6308. they depend. For example, if you append the list of tests with two
  6309. tests (``test_A`` and ``test_B``) where ``test_B`` is dependent on
  6310. ``test_A``, then you must order the tests as follows:
  6311. ::
  6312. TEST_SUITES = "test_A test_B"
  6313. For more information on testing images, see the
  6314. ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
  6315. section in the Yocto Project Development Tasks Manual.
  6316. :term:`TEST_TARGET`
  6317. Specifies the target controller to use when running tests against a
  6318. test image. The default controller to use is "qemu":
  6319. ::
  6320. TEST_TARGET = "qemu"
  6321. A target controller is a class that defines how an image gets
  6322. deployed on a target and how a target is started. A layer can extend
  6323. the controllers by adding a module in the layer's
  6324. ``/lib/oeqa/controllers`` directory and by inheriting the
  6325. ``BaseTarget`` class, which is an abstract class that cannot be used
  6326. as a value of ``TEST_TARGET``.
  6327. You can provide the following arguments with ``TEST_TARGET``:
  6328. - *"qemu":* Boots a QEMU image and runs the tests. See the
  6329. ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section
  6330. in the Yocto Project Development Tasks Manual for more
  6331. information.
  6332. - *"simpleremote":* Runs the tests on target hardware that is
  6333. already up and running. The hardware can be on the network or it
  6334. can be a device running an image on QEMU. You must also set
  6335. :term:`TEST_TARGET_IP` when you use
  6336. "simpleremote".
  6337. .. note::
  6338. This argument is defined in
  6339. ``meta/lib/oeqa/controllers/simpleremote.py``.
  6340. For information on running tests on hardware, see the
  6341. ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`"
  6342. section in the Yocto Project Development Tasks Manual.
  6343. :term:`TEST_TARGET_IP`
  6344. The IP address of your hardware under test. The ``TEST_TARGET_IP``
  6345. variable has no effect when :term:`TEST_TARGET` is
  6346. set to "qemu".
  6347. When you specify the IP address, you can also include a port. Here is
  6348. an example:
  6349. ::
  6350. TEST_TARGET_IP = "192.168.1.4:2201"
  6351. Specifying a port is
  6352. useful when SSH is started on a non-standard port or in cases when
  6353. your hardware under test is behind a firewall or network that is not
  6354. directly accessible from your host and you need to do port address
  6355. translation.
  6356. :term:`TESTIMAGE_AUTO`
  6357. Automatically runs the series of automated tests for images when an
  6358. image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes
  6359. any image that successfully builds to automatically boot under QEMU.
  6360. Using the variable also adds in dependencies so that any SDK for
  6361. which testing is requested is automatically built first.
  6362. These tests are written in Python making use of the ``unittest``
  6363. module, and the majority of them run commands on the target system
  6364. over ``ssh``. You can set this variable to "1" in your ``local.conf``
  6365. file in the :term:`Build Directory` to have the
  6366. OpenEmbedded build system automatically run these tests after an
  6367. image successfully builds:
  6368. TESTIMAGE_AUTO = "1"
  6369. For more information
  6370. on enabling, running, and writing these tests, see the
  6371. ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
  6372. section in the Yocto Project Development Tasks Manual and the
  6373. ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section.
  6374. :term:`THISDIR`
  6375. The directory in which the file BitBake is currently parsing is
  6376. located. Do not manually set this variable.
  6377. :term:`TIME`
  6378. The time the build was started. Times appear using the hour, minute,
  6379. and second (HMS) format (e.g. "140159" for one minute and fifty-nine
  6380. seconds past 1400 hours).
  6381. :term:`TMPDIR`
  6382. This variable is the base directory the OpenEmbedded build system
  6383. uses for all build output and intermediate files (other than the
  6384. shared state cache). By default, the ``TMPDIR`` variable points to
  6385. ``tmp`` within the :term:`Build Directory`.
  6386. If you want to establish this directory in a location other than the
  6387. default, you can uncomment and edit the following statement in the
  6388. ``conf/local.conf`` file in the :term:`Source Directory`:
  6389. ::
  6390. #TMPDIR = "${TOPDIR}/tmp"
  6391. An example use for this scenario is to set ``TMPDIR`` to a local disk,
  6392. which does not use NFS, while having the Build Directory use NFS.
  6393. The filesystem used by ``TMPDIR`` must have standard filesystem
  6394. semantics (i.e. mixed-case files are unique, POSIX file locking, and
  6395. persistent inodes). Due to various issues with NFS and bugs in some
  6396. implementations, NFS does not meet this minimum requirement.
  6397. Consequently, ``TMPDIR`` cannot be on NFS.
  6398. :term:`TOOLCHAIN_HOST_TASK`
  6399. This variable lists packages the OpenEmbedded build system uses when
  6400. building an SDK, which contains a cross-development environment. The
  6401. packages specified by this variable are part of the toolchain set
  6402. that runs on the :term:`SDKMACHINE`, and each
  6403. package should usually have the prefix ``nativesdk-``. For example,
  6404. consider the following command when building an SDK:
  6405. ::
  6406. $ bitbake -c populate_sdk imagename
  6407. In this case, a default list of packages is
  6408. set in this variable, but you can add additional packages to the
  6409. list. See the
  6410. ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section
  6411. in the Yocto Project Application Development and the Extensible
  6412. Software Development Kit (eSDK) manual for more information.
  6413. For background information on cross-development toolchains in the
  6414. Yocto Project development environment, see the
  6415. ":ref:`sdk-manual/intro:the cross-development toolchain`"
  6416. section in the Yocto Project Overview and Concepts Manual. For
  6417. information on setting up a cross-development environment, see the
  6418. :doc:`/sdk-manual/index` manual.
  6419. :term:`TOOLCHAIN_OUTPUTNAME`
  6420. This variable defines the name used for the toolchain output. The
  6421. :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets
  6422. the ``TOOLCHAIN_OUTPUTNAME`` variable as follows:
  6423. ::
  6424. TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}"
  6425. See
  6426. the :term:`SDK_NAME` and
  6427. :term:`SDK_VERSION` variables for additional
  6428. information.
  6429. :term:`TOOLCHAIN_TARGET_TASK`
  6430. This variable lists packages the OpenEmbedded build system uses when
  6431. it creates the target part of an SDK (i.e. the part built for the
  6432. target hardware), which includes libraries and headers. Use this
  6433. variable to add individual packages to the part of the SDK that runs
  6434. on the target. See the
  6435. ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section
  6436. in the Yocto Project Application Development and the Extensible
  6437. Software Development Kit (eSDK) manual for more information.
  6438. For background information on cross-development toolchains in the
  6439. Yocto Project development environment, see the
  6440. ":ref:`sdk-manual/intro:the cross-development toolchain`"
  6441. section in the Yocto Project Overview and Concepts Manual. For
  6442. information on setting up a cross-development environment, see the
  6443. :doc:`/sdk-manual/index` manual.
  6444. :term:`TOPDIR`
  6445. The top-level :term:`Build Directory`. BitBake
  6446. automatically sets this variable when you initialize your build
  6447. environment using :ref:`structure-core-script`.
  6448. :term:`TRANSLATED_TARGET_ARCH`
  6449. A sanitized version of :term:`TARGET_ARCH`. This
  6450. variable is used where the architecture is needed in a value where
  6451. underscores are not allowed, for example within package filenames. In
  6452. this case, dash characters replace any underscore characters used in
  6453. ``TARGET_ARCH``.
  6454. Do not edit this variable.
  6455. :term:`TUNE_ARCH`
  6456. The GNU canonical architecture for a specific architecture (i.e.
  6457. ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses
  6458. this value to setup configuration.
  6459. ``TUNE_ARCH`` definitions are specific to a given architecture. The
  6460. definitions can be a single static definition, or can be dynamically
  6461. adjusted. You can see details for a given CPU family by looking at
  6462. the architecture's ``README`` file. For example, the
  6463. ``meta/conf/machine/include/mips/README`` file in the
  6464. :term:`Source Directory` provides information for
  6465. ``TUNE_ARCH`` specific to the ``mips`` architecture.
  6466. ``TUNE_ARCH`` is tied closely to
  6467. :term:`TARGET_ARCH`, which defines the target
  6468. machine's architecture. The BitBake configuration file
  6469. (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows:
  6470. ::
  6471. TARGET_ARCH = "${TUNE_ARCH}"
  6472. The following list, which is by no means complete since architectures
  6473. are configurable, shows supported machine architectures:
  6474. - arm
  6475. - i586
  6476. - x86_64
  6477. - powerpc
  6478. - powerpc64
  6479. - mips
  6480. - mipsel
  6481. :term:`TUNE_ASARGS`
  6482. Specifies architecture-specific assembler flags for the target
  6483. system. The set of flags is based on the selected tune features.
  6484. ``TUNE_ASARGS`` is set using the tune include files, which are
  6485. typically under ``meta/conf/machine/include/`` and are influenced
  6486. through :term:`TUNE_FEATURES`. For example, the
  6487. ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags
  6488. for the x86 architecture as follows:
  6489. ::
  6490. TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}"
  6491. .. note::
  6492. Board Support Packages (BSPs) select the tune. The selected tune,
  6493. in turn, affects the tune variables themselves (i.e. the tune can
  6494. supply its own set of flags).
  6495. :term:`TUNE_CCARGS`
  6496. Specifies architecture-specific C compiler flags for the target
  6497. system. The set of flags is based on the selected tune features.
  6498. ``TUNE_CCARGS`` is set using the tune include files, which are
  6499. typically under ``meta/conf/machine/include/`` and are influenced
  6500. through :term:`TUNE_FEATURES`.
  6501. .. note::
  6502. Board Support Packages (BSPs) select the tune. The selected tune,
  6503. in turn, affects the tune variables themselves (i.e. the tune can
  6504. supply its own set of flags).
  6505. :term:`TUNE_FEATURES`
  6506. Features used to "tune" a compiler for optimal use given a specific
  6507. processor. The features are defined within the tune files and allow
  6508. arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on
  6509. the features.
  6510. The OpenEmbedded build system verifies the features to be sure they
  6511. are not conflicting and that they are supported.
  6512. The BitBake configuration file (``meta/conf/bitbake.conf``) defines
  6513. ``TUNE_FEATURES`` as follows:
  6514. ::
  6515. TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}"
  6516. See the :term:`DEFAULTTUNE` variable for more information.
  6517. :term:`TUNE_LDARGS`
  6518. Specifies architecture-specific linker flags for the target system.
  6519. The set of flags is based on the selected tune features.
  6520. ``TUNE_LDARGS`` is set using the tune include files, which are
  6521. typically under ``meta/conf/machine/include/`` and are influenced
  6522. through :term:`TUNE_FEATURES`. For example, the
  6523. ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags
  6524. for the x86 architecture as follows:
  6525. ::
  6526. TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}"
  6527. .. note::
  6528. Board Support Packages (BSPs) select the tune. The selected tune,
  6529. in turn, affects the tune variables themselves (i.e. the tune can
  6530. supply its own set of flags).
  6531. :term:`TUNE_PKGARCH`
  6532. The package architecture understood by the packaging system to define
  6533. the architecture, ABI, and tuning of output packages. The specific
  6534. tune is defined using the "_tune" override as follows:
  6535. ::
  6536. TUNE_PKGARCH_tune-tune = "tune"
  6537. These tune-specific package architectures are defined in the machine
  6538. include files. Here is an example of the "core2-32" tuning as used in
  6539. the ``meta/conf/machine/include/tune-core2.inc`` file:
  6540. ::
  6541. TUNE_PKGARCH_tune-core2-32 = "core2-32"
  6542. :term:`TUNEABI`
  6543. An underlying Application Binary Interface (ABI) used by a particular
  6544. tuning in a given toolchain layer. Providers that use prebuilt
  6545. libraries can use the ``TUNEABI``,
  6546. :term:`TUNEABI_OVERRIDE`, and
  6547. :term:`TUNEABI_WHITELIST` variables to check
  6548. compatibility of tunings against their selection of libraries.
  6549. If ``TUNEABI`` is undefined, then every tuning is allowed. See the
  6550. :ref:`sanity <ref-classes-sanity>` class to see how the variable is
  6551. used.
  6552. :term:`TUNEABI_OVERRIDE`
  6553. If set, the OpenEmbedded system ignores the
  6554. :term:`TUNEABI_WHITELIST` variable.
  6555. Providers that use prebuilt libraries can use the
  6556. ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and
  6557. :term:`TUNEABI` variables to check compatibility of a
  6558. tuning against their selection of libraries.
  6559. See the :ref:`sanity <ref-classes-sanity>` class to see how the
  6560. variable is used.
  6561. :term:`TUNEABI_WHITELIST`
  6562. A whitelist of permissible :term:`TUNEABI` values. If
  6563. ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers
  6564. that use prebuilt libraries can use the ``TUNEABI_WHITELIST``,
  6565. :term:`TUNEABI_OVERRIDE`, and ``TUNEABI``
  6566. variables to check compatibility of a tuning against their selection
  6567. of libraries.
  6568. See the :ref:`sanity <ref-classes-sanity>` class to see how the
  6569. variable is used.
  6570. :term:`TUNECONFLICTS[feature]`
  6571. Specifies CPU or Application Binary Interface (ABI) tuning features
  6572. that conflict with feature.
  6573. Known tuning conflicts are specified in the machine include files in
  6574. the :term:`Source Directory`. Here is an example from
  6575. the ``meta/conf/machine/include/mips/arch-mips.inc`` include file
  6576. that lists the "o32" and "n64" features as conflicting with the "n32"
  6577. feature:
  6578. ::
  6579. TUNECONFLICTS[n32] = "o32 n64"
  6580. :term:`TUNEVALID[feature]`
  6581. Specifies a valid CPU or Application Binary Interface (ABI) tuning
  6582. feature. The specified feature is stored as a flag. Valid features
  6583. are specified in the machine include files (e.g.
  6584. ``meta/conf/machine/include/arm/arch-arm.inc``). Here is an example
  6585. from that file:
  6586. ::
  6587. TUNEVALID[bigendian] = "Enable big-endian mode."
  6588. See the machine include files in the :term:`Source Directory`
  6589. for these features.
  6590. :term:`UBOOT_CONFIG`
  6591. Configures the :term:`UBOOT_MACHINE` and can
  6592. also define :term:`IMAGE_FSTYPES` for individual
  6593. cases.
  6594. Following is an example from the ``meta-fsl-arm`` layer. ::
  6595. UBOOT_CONFIG ??= "sd"
  6596. UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard"
  6597. UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config"
  6598. UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs"
  6599. UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config"
  6600. In this example, "sd" is selected as the configuration of the possible four for the
  6601. ``UBOOT_MACHINE``. The "sd" configuration defines
  6602. "mx6qsabreauto_config" as the value for ``UBOOT_MACHINE``, while the
  6603. "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-Boot image.
  6604. For more information on how the ``UBOOT_CONFIG`` is handled, see the
  6605. :ref:`uboot-config <ref-classes-uboot-config>`
  6606. class.
  6607. :term:`UBOOT_DTB_LOADADDRESS`
  6608. Specifies the load address for the dtb image used by U-Boot. During FIT
  6609. image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in
  6610. :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify
  6611. the load address to be used in
  6612. creating the dtb sections of Image Tree Source for the FIT image.
  6613. :term:`UBOOT_DTBO_LOADADDRESS`
  6614. Specifies the load address for the dtbo image used by U-Boot. During FIT
  6615. image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in
  6616. :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in
  6617. creating the dtbo sections of Image Tree Source for the FIT image.
  6618. :term:`UBOOT_ENTRYPOINT`
  6619. Specifies the entry point for the U-Boot image. During U-Boot image
  6620. creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a
  6621. command-line parameter to the ``uboot-mkimage`` utility.
  6622. :term:`UBOOT_LOADADDRESS`
  6623. Specifies the load address for the U-Boot image. During U-Boot image
  6624. creation, the ``UBOOT_LOADADDRESS`` variable is passed as a
  6625. command-line parameter to the ``uboot-mkimage`` utility.
  6626. :term:`UBOOT_LOCALVERSION`
  6627. Appends a string to the name of the local version of the U-Boot
  6628. image. For example, assuming the version of the U-Boot image built
  6629. was "2013.10", the full version string reported by U-Boot would be
  6630. "2013.10-yocto" given the following statement:
  6631. ::
  6632. UBOOT_LOCALVERSION = "-yocto"
  6633. :term:`UBOOT_MACHINE`
  6634. Specifies the value passed on the ``make`` command line when building
  6635. a U-Boot image. The value indicates the target platform
  6636. configuration. You typically set this variable from the machine
  6637. configuration file (i.e. ``conf/machine/machine_name.conf``).
  6638. Please see the "Selection of Processor Architecture and Board Type"
  6639. section in the U-Boot README for valid values for this variable.
  6640. :term:`UBOOT_MAKE_TARGET`
  6641. Specifies the target called in the ``Makefile``. The default target
  6642. is "all".
  6643. :term:`UBOOT_MKIMAGE`
  6644. Specifies the name of the mkimage command as used by the
  6645. :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to assemble
  6646. the FIT image. This can be used to substitute an alternative command, wrapper
  6647. script or function if desired. The default is "uboot-mkimage".
  6648. :term:`UBOOT_MKIMAGE_DTCOPTS`
  6649. Options for the device tree compiler passed to mkimage '-D'
  6650. feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class.
  6651. If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not
  6652. pass the ``-D`` option to mkimage.
  6653. :term:`UBOOT_MKIMAGE_SIGN`
  6654. Specifies the name of the mkimage command as used by the
  6655. :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to sign
  6656. the FIT image after it has been assembled (if enabled). This can be used
  6657. to substitute an alternative command, wrapper script or function if
  6658. desired. The default is "${:term:`UBOOT_MKIMAGE`}".
  6659. :term:`UBOOT_MKIMAGE_SIGN_ARGS`
  6660. Optionally specifies additional arguments for the
  6661. :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to pass to the
  6662. mkimage command when signing the FIT image.
  6663. :term:`UBOOT_RD_ENTRYPOINT`
  6664. Specifies the entrypoint for the RAM disk image.
  6665. During FIT image creation, the
  6666. ``UBOOT_RD_ENTRYPOINT`` variable is used
  6667. in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the
  6668. entrypoint to be used in creating the Image Tree Source for
  6669. the FIT image.
  6670. :term:`UBOOT_RD_LOADADDRESS`
  6671. Specifies the load address for the RAM disk image.
  6672. During FIT image creation, the
  6673. ``UBOOT_RD_LOADADDRESS`` variable is used
  6674. in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the
  6675. load address to be used in creating the Image Tree Source for
  6676. the FIT image.
  6677. :term:`UBOOT_SIGN_ENABLE`
  6678. Enable signing of FIT image. The default value is "0".
  6679. :term:`UBOOT_SIGN_KEYDIR`
  6680. Location of the directory containing the RSA key and
  6681. certificate used for signing FIT image.
  6682. :term:`UBOOT_SIGN_KEYNAME`
  6683. The name of keys used for signing U-Boot FIT image stored in
  6684. :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt
  6685. certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have
  6686. :term:`UBOOT_SIGN_KEYNAME` set to "dev".
  6687. :term:`UBOOT_SUFFIX`
  6688. Points to the generated U-Boot extension. For example, ``u-boot.sb``
  6689. has a ``.sb`` extension.
  6690. The default U-Boot extension is ``.bin``
  6691. :term:`UBOOT_TARGET`
  6692. Specifies the target used for building U-Boot. The target is passed
  6693. directly as part of the "make" command (e.g. SPL and AIS). If you do
  6694. not specifically set this variable, the OpenEmbedded build process
  6695. passes and uses "all" for the target during the U-Boot building
  6696. process.
  6697. :term:`UNKNOWN_CONFIGURE_WHITELIST`
  6698. Specifies a list of options that, if reported by the configure script
  6699. as being invalid, should not generate a warning during the
  6700. :ref:`ref-tasks-configure` task. Normally, invalid
  6701. configure options are simply not passed to the configure script (e.g.
  6702. should be removed from :term:`EXTRA_OECONF` or
  6703. :term:`PACKAGECONFIG_CONFARGS`).
  6704. However, common options, for example, exist that are passed to all
  6705. configure scripts at a class level that might not be valid for some
  6706. configure scripts. It follows that no benefit exists in seeing a
  6707. warning about these options. For these cases, the options are added
  6708. to ``UNKNOWN_CONFIGURE_WHITELIST``.
  6709. The configure arguments check that uses
  6710. ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the
  6711. :ref:`insane <ref-classes-insane>` class and is only enabled if the
  6712. recipe inherits the :ref:`autotools <ref-classes-autotools>` class.
  6713. :term:`UPDATERCPN`
  6714. For recipes inheriting the
  6715. :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN``
  6716. specifies the package that contains the initscript that is enabled.
  6717. The default value is "${PN}". Given that almost all recipes that
  6718. install initscripts package them in the main package for the recipe,
  6719. you rarely need to set this variable in individual recipes.
  6720. :term:`UPSTREAM_CHECK_GITTAGREGEX`
  6721. You can perform a per-recipe check for what the latest upstream
  6722. source code version is by calling ``bitbake -c checkpkg`` recipe. If
  6723. the recipe source code is provided from Git repositories, the
  6724. OpenEmbedded build system determines the latest upstream version by
  6725. picking the latest tag from the list of all repository tags.
  6726. You can use the ``UPSTREAM_CHECK_GITTAGREGEX`` variable to provide a
  6727. regular expression to filter only the relevant tags should the
  6728. default filter not work correctly.
  6729. ::
  6730. UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
  6731. :term:`UPSTREAM_CHECK_REGEX`
  6732. Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different
  6733. regular expression instead of the default one when the package
  6734. checking system is parsing the page found using
  6735. :term:`UPSTREAM_CHECK_URI`.
  6736. ::
  6737. UPSTREAM_CHECK_REGEX = "package_regex"
  6738. :term:`UPSTREAM_CHECK_URI`
  6739. You can perform a per-recipe check for what the latest upstream
  6740. source code version is by calling ``bitbake -c checkpkg`` recipe. If
  6741. the source code is provided from tarballs, the latest version is
  6742. determined by fetching the directory listing where the tarball is and
  6743. attempting to find a later tarball. When this approach does not work,
  6744. you can use ``UPSTREAM_CHECK_URI`` to provide a different URI that
  6745. contains the link to the latest tarball.
  6746. ::
  6747. UPSTREAM_CHECK_URI = "recipe_url"
  6748. :term:`USE_DEVFS`
  6749. Determines if ``devtmpfs`` is used for ``/dev`` population. The
  6750. default value used for ``USE_DEVFS`` is "1" when no value is
  6751. specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a
  6752. statically populated ``/dev`` directory.
  6753. See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in
  6754. the Yocto Project Development Tasks Manual for information on how to
  6755. use this variable.
  6756. :term:`USE_VT`
  6757. When using
  6758. :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`,
  6759. determines whether or not to run a
  6760. `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any
  6761. virtual terminals in order to enable logging in through those
  6762. terminals.
  6763. The default value used for ``USE_VT`` is "1" when no default value is
  6764. specifically set. Typically, you would set ``USE_VT`` to "0" in the
  6765. machine configuration file for machines that do not have a graphical
  6766. display attached and therefore do not need virtual terminal
  6767. functionality.
  6768. :term:`USER_CLASSES`
  6769. A list of classes to globally inherit. These classes are used by the
  6770. OpenEmbedded build system to enable extra features (e.g.
  6771. ``buildstats``, ``image-mklibs``, and so forth).
  6772. The default list is set in your ``local.conf`` file:
  6773. ::
  6774. USER_CLASSES ?= "buildstats image-mklibs image-prelink"
  6775. For more information, see
  6776. ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`.
  6777. :term:`USERADD_ERROR_DYNAMIC`
  6778. If set to ``error``, forces the OpenEmbedded build system to produce
  6779. an error if the user identification (``uid``) and group
  6780. identification (``gid``) values are not defined in any of the files
  6781. listed in :term:`USERADD_UID_TABLES` and
  6782. :term:`USERADD_GID_TABLES`. If set to
  6783. ``warn``, a warning will be issued instead.
  6784. The default behavior for the build system is to dynamically apply
  6785. ``uid`` and ``gid`` values. Consequently, the
  6786. ``USERADD_ERROR_DYNAMIC`` variable is by default not set. If you plan
  6787. on using statically assigned ``gid`` and ``uid`` values, you should
  6788. set the ``USERADD_ERROR_DYNAMIC`` variable in your ``local.conf``
  6789. file as follows:
  6790. ::
  6791. USERADD_ERROR_DYNAMIC = "error"
  6792. Overriding the
  6793. default behavior implies you are going to also take steps to set
  6794. static ``uid`` and ``gid`` values through use of the
  6795. :term:`USERADDEXTENSION`,
  6796. :term:`USERADD_UID_TABLES`, and
  6797. :term:`USERADD_GID_TABLES` variables.
  6798. .. note::
  6799. There is a difference in behavior between setting
  6800. ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``.
  6801. When it is set to ``warn``, the build system will report a warning for
  6802. every undefined ``uid`` and ``gid`` in any recipe. But when it is set
  6803. to ``error``, it will only report errors for recipes that are actually
  6804. built.
  6805. This saves you from having to add static IDs for recipes that you
  6806. know will never be built.
  6807. :term:`USERADD_GID_TABLES`
  6808. Specifies a password file to use for obtaining static group
  6809. identification (``gid``) values when the OpenEmbedded build system
  6810. adds a group to the system during package installation.
  6811. When applying static group identification (``gid``) values, the
  6812. OpenEmbedded build system looks in :term:`BBPATH` for a
  6813. ``files/group`` file and then applies those ``uid`` values. Set the
  6814. variable as follows in your ``local.conf`` file:
  6815. ::
  6816. USERADD_GID_TABLES = "files/group"
  6817. .. note::
  6818. Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
  6819. causes the build system to use static ``gid`` values.
  6820. :term:`USERADD_PACKAGES`
  6821. When inheriting the :ref:`useradd <ref-classes-useradd>` class,
  6822. this variable specifies the individual packages within the recipe
  6823. that require users and/or groups to be added.
  6824. You must set this variable if the recipe inherits the class. For
  6825. example, the following enables adding a user for the main package in
  6826. a recipe:
  6827. ::
  6828. USERADD_PACKAGES = "${PN}"
  6829. .. note::
  6830. It follows that if you are going to use the ``USERADD_PACKAGES``
  6831. variable, you need to set one or more of the :term:`USERADD_PARAM`,
  6832. :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables.
  6833. :term:`USERADD_PARAM`
  6834. When inheriting the :ref:`useradd <ref-classes-useradd>` class,
  6835. this variable specifies for a package what parameters should pass to
  6836. the ``useradd`` command if you add a user to the system when the
  6837. package is installed.
  6838. Here is an example from the ``dbus`` recipe:
  6839. ::
  6840. USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \
  6841. --no-create-home --shell /bin/false \
  6842. --user-group messagebus"
  6843. For information on the
  6844. standard Linux shell command ``useradd``, see
  6845. https://linux.die.net/man/8/useradd.
  6846. :term:`USERADD_UID_TABLES`
  6847. Specifies a password file to use for obtaining static user
  6848. identification (``uid``) values when the OpenEmbedded build system
  6849. adds a user to the system during package installation.
  6850. When applying static user identification (``uid``) values, the
  6851. OpenEmbedded build system looks in :term:`BBPATH` for a
  6852. ``files/passwd`` file and then applies those ``uid`` values. Set the
  6853. variable as follows in your ``local.conf`` file:
  6854. ::
  6855. USERADD_UID_TABLES = "files/passwd"
  6856. .. note::
  6857. Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
  6858. causes the build system to use static ``uid`` values.
  6859. :term:`USERADDEXTENSION`
  6860. When set to "useradd-staticids", causes the OpenEmbedded build system
  6861. to base all user and group additions on a static ``passwd`` and
  6862. ``group`` files found in :term:`BBPATH`.
  6863. To use static user identification (``uid``) and group identification
  6864. (``gid``) values, set the variable as follows in your ``local.conf``
  6865. file: USERADDEXTENSION = "useradd-staticids"
  6866. .. note::
  6867. Setting this variable to use static ``uid`` and ``gid``
  6868. values causes the OpenEmbedded build system to employ the
  6869. :ref:`ref-classes-useradd` class.
  6870. If you use static ``uid`` and ``gid`` information, you must also
  6871. specify the ``files/passwd`` and ``files/group`` files by setting the
  6872. :term:`USERADD_UID_TABLES` and
  6873. :term:`USERADD_GID_TABLES` variables.
  6874. Additionally, you should also set the
  6875. :term:`USERADD_ERROR_DYNAMIC` variable.
  6876. :term:`VOLATILE_LOG_DIR`
  6877. Specifies the persistence of the target's ``/var/log`` directory,
  6878. which is used to house postinstall target log files.
  6879. By default, ``VOLATILE_LOG_DIR`` is set to "yes", which means the
  6880. file is not persistent. You can override this setting by setting the
  6881. variable to "no" to make the log directory persistent.
  6882. :term:`WARN_QA`
  6883. Specifies the quality assurance checks whose failures are reported as
  6884. warnings by the OpenEmbedded build system. You set this variable in
  6885. your distribution configuration file. For a list of the checks you
  6886. can control with this variable, see the
  6887. ":ref:`insane.bbclass <ref-classes-insane>`" section.
  6888. :term:`WKS_FILE`
  6889. Specifies the location of the Wic kickstart file that is used by the
  6890. OpenEmbedded build system to create a partitioned image
  6891. (image\ ``.wic``). For information on how to create a partitioned
  6892. image, see the
  6893. ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
  6894. section in the Yocto Project Development Tasks Manual. For details on
  6895. the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter.
  6896. :term:`WKS_FILE_DEPENDS`
  6897. When placed in the recipe that builds your image, this variable lists
  6898. build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only
  6899. applicable when Wic images are active (i.e. when
  6900. :term:`IMAGE_FSTYPES` contains entries related
  6901. to Wic). If your recipe does not create Wic images, the variable has
  6902. no effect.
  6903. The ``WKS_FILE_DEPENDS`` variable is similar to the
  6904. :term:`DEPENDS` variable. When you use the variable in
  6905. your recipe that builds the Wic image, dependencies you list in the
  6906. ``WIC_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable.
  6907. With the ``WKS_FILE_DEPENDS`` variable, you have the possibility to
  6908. specify a list of additional dependencies (e.g. native tools,
  6909. bootloaders, and so forth), that are required to build Wic images.
  6910. Following is an example:
  6911. ::
  6912. WKS_FILE_DEPENDS = "some-native-tool"
  6913. In the
  6914. previous example, some-native-tool would be replaced with an actual
  6915. native tool on which the build would depend.
  6916. :term:`WORKDIR`
  6917. The pathname of the work directory in which the OpenEmbedded build
  6918. system builds a recipe. This directory is located within the
  6919. :term:`TMPDIR` directory structure and is specific to
  6920. the recipe being built and the system for which it is being built.
  6921. The ``WORKDIR`` directory is defined as follows:
  6922. ::
  6923. ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
  6924. The actual directory depends on several things:
  6925. - :term:`TMPDIR`: The top-level build output directory
  6926. - :term:`MULTIMACH_TARGET_SYS`: The target system identifier
  6927. - :term:`PN`: The recipe name
  6928. - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which
  6929. is usually the case for most recipes, then `EXTENDPE` is blank)
  6930. - :term:`PV`: The recipe version
  6931. - :term:`PR`: The recipe revision
  6932. As an example, assume a Source Directory top-level folder name
  6933. ``poky``, a default Build Directory at ``poky/build``, and a
  6934. ``qemux86-poky-linux`` machine target system. Furthermore, suppose
  6935. your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work
  6936. directory the build system uses to build the package would be as
  6937. follows:
  6938. ::
  6939. poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
  6940. :term:`XSERVER`
  6941. Specifies the packages that should be installed to provide an X
  6942. server and drivers for the current machine, assuming your image
  6943. directly includes ``packagegroup-core-x11-xserver`` or, perhaps
  6944. indirectly, includes "x11-base" in
  6945. :term:`IMAGE_FEATURES`.
  6946. The default value of ``XSERVER``, if not specified in the machine
  6947. configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev".