releng/wiki
8
0
Fork 0
mirror of https://git.resf.org/sig_core/wiki.git synced 2024-11-16 20:31:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
afda1aad6a
wiki/documentation/debranding/patching/index.html

1468 lines
38 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The wiki for Rocky Linux Release Engineering (SIG/Core)">
<link rel="canonical" href="https://sig-core.rocky.page/documentation/debranding/patching/">
<link rel="prev" href="../debrand_info/">
<link rel="next" href="../../compose/">
<link rel="icon" href="../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">
<title>Rocky Patching Guide - Release Engineering (SIG/Core) Wiki</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.bcfcd587.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="teal">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#general-instructions" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="Release Engineering (SIG/Core) Wiki" class="md-header__button md-logo" aria-label="Release Engineering (SIG/Core) Wiki" data-md-component="logo">
<img src="../../../assets/icon-white.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Release Engineering (SIG/Core) Wiki
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Rocky Patching Guide
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="teal" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="teal" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.resf.org/sig_core/wiki" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
sig_core/wiki
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="Release Engineering (SIG/Core) Wiki" class="md-nav__button md-logo" aria-label="Release Engineering (SIG/Core) Wiki" data-md-component="logo">
<img src="../../../assets/icon-white.svg" alt="logo">
</a>
Release Engineering (SIG/Core) Wiki
</label>
<div class="md-nav__source">
<a href="https://git.resf.org/sig_core/wiki" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
sig_core/wiki
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Release Engineering (SIG/Core)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../members/" class="md-nav__link">
<span class="md-ellipsis">
Members
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../what_we_do/" class="md-nav__link">
<span class="md-ellipsis">
What We Do
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Documentation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../" class="md-nav__link">
<span class="md-ellipsis">
Release General Overview
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
<span class="md-ellipsis">
Guidelines
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Guidelines
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guidelines/rocky_logos_guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Rocky Logos Package Guidelines
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" checked>
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Debranding and Patching
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Debranding and Patching
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Intro to Debranding with Rocky Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../debrand_info/" class="md-nav__link">
<span class="md-ellipsis">
Debranding Information
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Patching Guide
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Patching Guide
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#general-instructions" class="md-nav__link">
<span class="md-ellipsis">
General Instructions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#the-patch-config-language" class="md-nav__link">
<span class="md-ellipsis">
The Patch Config Language
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#patch-configuration-options" class="md-nav__link">
<span class="md-ellipsis">
Patch configuration options
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#case-study-nginx" class="md-nav__link">
<span class="md-ellipsis">
Case Study: Nginx
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#more-debrand-config-language" class="md-nav__link">
<span class="md-ellipsis">
More Debrand Config Language
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
<span class="md-ellipsis">
Composing Releases
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Composing Releases
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../compose/" class="md-nav__link">
<span class="md-ellipsis">
Composing and Managing Releases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../compose/koji/" class="md-nav__link">
<span class="md-ellipsis">
Manual Updates in Koji
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../empanadas/" class="md-nav__link">
<span class="md-ellipsis">
Empanadas
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../peridot/" class="md-nav__link">
<span class="md-ellipsis">
Peridot
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_7" >
<label class="md-nav__link" for="__nav_4_7" id="__nav_4_7_label" tabindex="0">
<span class="md-ellipsis">
References
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_7">
<span class="md-nav__icon md-icon"></span>
References
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../references/" class="md-nav__link">
<span class="md-ellipsis">
References
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../references/empanadas_common/" class="md-nav__link">
<span class="md-ellipsis">
Empanadas common.py Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../references/empanadas_config/" class="md-nav__link">
<span class="md-ellipsis">
Empanadas config yaml Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../references/empanadas_sig_config/" class="md-nav__link">
<span class="md-ellipsis">
Empanadas SIG yaml Configuration
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
SOP
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
SOP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../sop/" class="md-nav__link">
<span class="md-ellipsis">
SOP (Standard Operationg Procedures)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../sop/sop_release/" class="md-nav__link">
<span class="md-ellipsis">
Release Procedures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../sop/sop_compose_8/" class="md-nav__link">
<span class="md-ellipsis">
Compose and Repo Sync for Rocky Linux 8
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../sop/sop_compose/" class="md-nav__link">
<span class="md-ellipsis">
Compose and Repo Sync for Rocky Linux and Peridot
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../sop/sop_compose_sig/" class="md-nav__link">
<span class="md-ellipsis">
Compose and Repo Sync for Rocky Linux Special Interest Groups
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../sop/sop_upstream_prep_checklist/" class="md-nav__link">
<span class="md-ellipsis">
Generalized Prep Checklist for Upcoming Releases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../sop/sop_mirrormanager2/" class="md-nav__link">
<span class="md-ellipsis">
Mirror Manager
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Events
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Events
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
<label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
<span class="md-ellipsis">
Meeting notes
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
Meeting notes
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../events/meeting-notes/2024-03-18/" class="md-nav__link">
<span class="md-ellipsis">
Release Engineering (SIG/Core) Meeting 2024-03-18
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Patching Guide</h1>
<p>This explains how to debrand/patch a package for the Rocky Linux distribution.</p>
<h2 id="general-instructions">General Instructions<a class="headerlink" href="#general-instructions" title="Permanent link">&para;</a></h2>
<ul>
<li>First, identify the files in the package that need to be changed. They could be text files, image files, or others. You can identify the file(s) by digging into git.centos.org/rpms/PACKAGE/</li>
<li>Develop replacements for these files, but with Rocky branding placed instead. Diff/patch files may be needed as well for certain types of text, depends on the content being replaced.</li>
<li>Replacement files go under https://git.rockylinux.org/patch/PACKAGE/ROCKY/_supporting/</li>
<li>Config file (specifying how to apply the patches) goes in https://git.rockylinux.org/patch/PACKAGE/ROCKY/CFG/*.cfg</li>
<li>Note: Use spaces, not tabs.</li>
<li>When srpmproc goes to import the package to Rocky, it will see the work done in https://git.rockylinux.org/patch/PACKAGE , and apply the stored patches by reading the config file(s) under ROCKY/CFG/*.cfg</li>
</ul>
<h2 id="the-patch-config-language">The Patch Config Language<a class="headerlink" href="#the-patch-config-language" title="Permanent link">&para;</a></h2>
<p>Patching uses simple proto3 config files. The general format is:
<div class="highlight"><pre><span></span><code>Action {
file: &quot;OriginalFile&quot;
with_file: &quot;ROCKY/_supporting/RockyReplaceFile&quot;
}
</code></pre></div></p>
<p>A simple example to replace a file:
<div class="highlight"><pre><span></span><code>replace {
file: &quot;redhatlogo.png&quot;
with_file: &quot;ROCKY/_supporting/rockylogo.png&quot;
}
</code></pre></div></p>
<p>The file "redhatlogo.png" would be located in under SOURCES/ in the project's Git repository (and SRPM).</p>
<h2 id="patch-configuration-options">Patch configuration options<a class="headerlink" href="#patch-configuration-options" title="Permanent link">&para;</a></h2>
<ul>
<li><code>add</code>: Adds a file to the sources using the <code>file</code> or <code>lookaside</code> directive</li>
<li><code>delete</code>: Deletes a file from the sources using the <code>file</code> directive</li>
<li><code>replace</code>: Replaces a file from the sources using the <code>file</code> and <code>with_file</code> directives</li>
<li><code>patch</code>: Performs a patch based on the diff provided in the <code>file</code> directive (generated using <code>git diff</code>)</li>
<li><code>spec_change</code>: Allows for spec files to be modified</li>
<li><code>search_and_replace</code>: Performs a search and replace on a given text for the spec file using the <code>any/starts_with/ends_with</code> (true|false), <code>find</code> (string to find), <code>replace</code> (replacement string), and <code>n</code> (integar, <code>-1</code> for any) directives.</li>
<li><code>file</code>: A file can be added to the spec file using the <code>name</code> directive to define the file name, the <code>type</code> directive (such as <code>patch</code>) and then an <code>add</code> option that is <code>true</code> or <code>false</code><ul>
<li>When <code>patch</code> is used, the following options are available:</li>
<li><code>add_to_prep</code> (true|false)</li>
<li><code>n_path: N</code> can be specified to add <code>%patchX -pN</code> lines into <code>%prep</code> assuming the rpm does not use <code>%autosetup</code></li>
</ul>
</li>
<li><code>append</code>: Appends to a given <code>field</code>, such as <code>Release</code> with a <code>value</code> directive</li>
<li><code>changelog</code>: Modifies the change log using <code>author_name</code>, <code>author_email</code>, and <code>message</code> directives</li>
</ul>
<p>Patch configuration structure:</p>
<div class="highlight"><pre><span></span><code>.
└── ROCKY
├── CFG
└── _supporting
</code></pre></div>
<h2 id="case-study-nginx">Case Study: Nginx<a class="headerlink" href="#case-study-nginx" title="Permanent link">&para;</a></h2>
<p><strong>(note: all example data here is currently in the staging/ area of Rocky Linux Git. We will update it when the projects are moved to the production area)</strong></p>
<p>Let's go over an example debrand, featuring the Nginx web server package.</p>
<p>The source repository is located here: <strong>https://git.centos.org/rpms/nginx</strong></p>
<p>If we browse one of the c8-* branches, we see under SOURCES/ that there is definitely some content that needs to be debranded:</p>
<div class="highlight"><pre><span></span><code>404.html
50x.html
index.html
poweredby.png (binary file in dist-git, referred to in .nginx.metadata)
</code></pre></div>
<p>These files all refer to Red Hat inc., and must be replaced before they make it to Rocky Linux.</p>
<p><strong>1: Come up with the patches:</strong> Each of these files has a Rocky Linux counterpart, and they must be created. <strong>Some of this should be done by the Design Team, especially logo work (#Design on chat)</strong></p>
<p><strong>2: Commit patches to the matching patch/PROJECT Git repository</strong> : For example, Nginx patches are located here: <strong>https://git.rockylinux.org/staging/patch/nginx</strong> (staging/ prefix is currently used until our production repos are set up)</p>
<p><strong>3: Develop a matching config file:</strong> Our example Nginx has this here: <strong>https://git.rockylinux.org/staging/patch/nginx/-/blob/main/ROCKY/CFG/pages.cfg</strong></p>
<p>It looks like this:
<div class="highlight"><pre><span></span><code>replace {
file: &quot;index.html&quot;
with_file: &quot;ROCKY/_supporting/index.html&quot;
}
replace {
file: &quot;404.html&quot;
with_file: &quot;ROCKY/_supporting/404.html&quot;
}
replace {
file: &quot;50x.html&quot;
with_file: &quot;ROCKY/_supporting/50x.html&quot;
}
replace {
file: &quot;poweredby.png&quot;
with_file: &quot;ROCKY/_supporting/poweredby.png&quot;
}
</code></pre></div></p>
<p><strong>4: Test the import:</strong> Now, when the upstream is imported, we can check the main Rocky <strong>nginx</strong> repository and ensure our updates were successful: <strong>https://git.rockylinux.org/staging/rpms/nginx/</strong> (again, staging/ group is used only for now)</p>
<p><strong>5: You're Done!</strong> Great! Now do the next one... ;-)</p>
<h2 id="more-debrand-config-language">More Debrand Config Language<a class="headerlink" href="#more-debrand-config-language" title="Permanent link">&para;</a></h2>
<p>The Nginx example showed just the <strong>replace</strong> directive, but there are several more available. They are <strong>add</strong>, <strong>patch</strong>, and <strong>delete.</strong></p>
<p>Here they are, with examples:</p>
<div class="highlight"><pre><span></span><code># Add a file to the project (file is added to SOURCES/ folder )
add {
file: &quot;ROCKY/_supporting/add_me.txt&quot;
}
# Apply a .patch file (generated using the Linux &quot;patch&quot; utility)
patch {
file: &quot;ROCKY/_supporting/002-test-html.patch&quot;
}
# Delete a file from the source project
delete {
file: &quot;SOURCES/dontneed.txt&quot;
}
</code></pre></div>
<p>And the .patch file example looks like this:
<div class="highlight"><pre><span></span><code>diff --git a/SOURCES/test.html b/SOURCES/test.html
index 8d91ffd..3f76c3b 100644
--- a/SOURCES/test.html
+++ b/SOURCES/test.html
@@ -1,6 +1,6 @@
&lt;!DOCTYPE html&gt;
&lt;html&gt;
&lt;body&gt;
- &lt;h1&gt;Replace me&lt;/h1&gt;
+ &lt;h1&gt;Replace I did!&lt;/h1&gt;
&lt;/body&gt;
&lt;/html&gt;
</code></pre></div></p>
<p>It also supports spec file changes, as it may be necessary. For example, from the anaconda debrand patch repo.</p>
<div class="highlight"><pre><span></span><code>add {
file: &quot;ROCKY/_supporting/0002-Rocky-disable-cdn-radiobutton.patch&quot;
}
spec_change {
# Adds a Patch line with the file name as listed above
file {
name: &quot;0002-Rocky-disable-cdn-radiobutton.patch&quot;
type: Patch
add: true
}
# Appends to the end of a field&#39;s line, in this case the Release field gets .rocky
append {
field: &quot;Release&quot;
value: &quot;.rocky&quot;
}
# Adds to the change log properly
changelog {
author_name: &quot;Mustafa Gezen&quot;
author_email: &quot;mustafa@rockylinux.org&quot;
message: &quot;Disable CDN and add .rocky to Release&quot;
}
}
</code></pre></div>
<p>At the end, the spec file should be changed.</p>
<div class="highlight"><pre><span></span><code>Summary: Graphical system installer
Name: anaconda
Version: 33.16.3.26
# Our .rocky appears here
Release: 2%{?dist}.rocky
-- snip --
Patch1: 0001-network-do-not-crash-on-infiniband-devices-activated.patch
# Look, our patch was added!
# Luckily this RPM uses %autosetup, so no %patch lines
Patch2: 0002-Rocky-disable-cdn-radiobutton.patch
-- snip --
# And below the added changelog
%changelog
* Thu Feb 25 2021 Mustafa Gezen &lt;mustafa@rockylinux.org&gt; - 33.16.3.26-2
- Disable CDN and add .rocky to Release
* Thu Oct 22 2020 Radek Vykydal &lt;rvykydal@redhat.com&gt; - 33.16.3.26-2
- network: do not crash on infiniband devices activated in initramfs
(rvykydal)
Resolves: rhbz#1890261
</code></pre></div>
<aside class="md-source-file">
<span class="md-source-file__fact">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
2024-04-07
</span>
</aside>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2024 Rocky Enterprise Software Foundation
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["search.highlight", "search.suggest", "toc.integrate"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../../assets/javascripts/bundle.1e8ae164.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink