mirror of
https://github.com/AskDavis/Getting-Started-With-ACPI.git
synced 2026-01-01 05:05:57 -08:00
610 lines
19 KiB
HTML
610 lines
19 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Contributing · GitBook</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.3">
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-search-plus/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-anchors/plugin.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-medium-zoom/plugin.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="styles/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
|
|
<link rel="prev" href="troubleshooting.html" />
|
|
|
|
|
|
<style>
|
|
@media only screen and (max-width: 640px) {
|
|
.book-header .hidden-mobile {
|
|
display: none;
|
|
}
|
|
}
|
|
</style>
|
|
<script>
|
|
window["gitbook-plugin-github-buttons"] = {"buttons":[{"user":"dortania","repo":"Getting-Started-With-ACPI","type":"star","size":"large"}]};
|
|
</script>
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="./">
|
|
|
|
<a href="./">
|
|
|
|
|
|
Getting Started With ACPI
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="ssdt-easy.html">
|
|
|
|
<a href="ssdt-easy.html">
|
|
|
|
|
|
SSDTs: Easy Way
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="ssdt-long.html">
|
|
|
|
<a href="ssdt-long.html">
|
|
|
|
|
|
SSDTs: Long Way
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Manual</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" data-path="Manual/dump.html">
|
|
|
|
<a href="Manual/dump.html">
|
|
|
|
|
|
Dumping the DSDT
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.2" data-path="Manual/compile.html">
|
|
|
|
<a href="Manual/compile.html">
|
|
|
|
|
|
Decompiling and Compiling
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Desktop</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="3.1" data-path="Desktops/desktop-disable.html">
|
|
|
|
<a href="Desktops/desktop-disable.html">
|
|
|
|
|
|
Disabling desktop dGPUs
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Laptop</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="4.1" data-path="Laptops/backlight.html">
|
|
|
|
<a href="Laptops/backlight.html">
|
|
|
|
|
|
Backlight PNLF
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.2" data-path="Laptops/trackpad.html">
|
|
|
|
<a href="Laptops/trackpad.html">
|
|
|
|
|
|
Trackpad GPI0
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="4.3" data-path="Laptops/laptop-disable.html">
|
|
|
|
<a href="Laptops/laptop-disable.html">
|
|
|
|
|
|
Disabling laptop dGPUs
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Universal</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="5.1" data-path="Universal/ec-fix.html">
|
|
|
|
<a href="Universal/ec-fix.html">
|
|
|
|
|
|
Embedded Controller
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.2" data-path="Universal/plug.html">
|
|
|
|
<a href="Universal/plug.html">
|
|
|
|
|
|
Plugin type
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.3" data-path="Universal/awac.html">
|
|
|
|
<a href="Universal/awac.html">
|
|
|
|
|
|
AWAC vs RTC
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.4" data-path="Universal/nvram.html">
|
|
|
|
<a href="Universal/nvram.html">
|
|
|
|
|
|
NVRAM PMC
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.5" data-path="Universal/irq.html">
|
|
|
|
<a href="Universal/irq.html">
|
|
|
|
|
|
IRQ Fix
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.6" data-path="Universal/spoof.html">
|
|
|
|
<a href="Universal/spoof.html">
|
|
|
|
|
|
GPU Spoof
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="5.7" data-path="Universal/smbus.html">
|
|
|
|
<a href="Universal/smbus.html">
|
|
|
|
|
|
Fixing SMBus Support
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Cleanup</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="6.1" data-path="cleanup.html">
|
|
|
|
<a href="cleanup.html">
|
|
|
|
|
|
Cleanup
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Misc</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="7.1" data-path="troubleshooting.html">
|
|
|
|
<a href="troubleshooting.html">
|
|
|
|
|
|
Troubleshooting
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="7.2" data-path="CONTRIBUTING.html">
|
|
|
|
<a href="CONTRIBUTING.html">
|
|
|
|
|
|
Contributing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href="." >Contributing</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div class="search-plus" id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<blockquote>
|
|
<p><em>Last modified: Fri May 01 2020 17:13:02 GMT+0000 (Coordinated Universal Time)</em></p>
|
|
</blockquote>
|
|
<h1 id="supporting-the-guides"><a name="supporting-the-guides" class="plugin-anchor" href="#supporting-the-guides"><i class="fa fa-link" aria-hidden="true"></i></a>Supporting the guides</h1>
|
|
<p><strong>Note</strong>: This is a community run guide which is not officially endorsed by Acidanthera. Please do not bug Acidanthera with issues about this guide.</p>
|
|
<p>Want to help support the guide? Well there's some ways you can help!</p>
|
|
<ul>
|
|
<li><a href="CONTRIBUTING.html#contributing-via-issues">Contributing via Issues</a></li>
|
|
<li><a href="CONTRIBUTING.html#contributing-via-prs">Contributing via PRs</a></li>
|
|
</ul>
|
|
<p>Note: For those wanting to contribute financially, we seriously appreciate it but we're a non-profit organization. We do this to teach, not to make money. If you have some money left over we highly recommend donating it to a charity. <a href="https://crohnsandcolitis.donorportal.ca/Donation/DonationDetails.aspx?L=en-CA&G=159&F=1097&T=GENER" target="_blank">Crohn's and Colitis Canada</a> is one we recommend if you have none on mind.</p>
|
|
<h2 id="contributing-via-issues"><a name="contributing-via-issues" class="plugin-anchor" href="#contributing-via-issues"><i class="fa fa-link" aria-hidden="true"></i></a>Contributing via Issues</h2>
|
|
<p> Contributing via Issues is pretty simple but there are some rules:</p>
|
|
<ul>
|
|
<li>Keep issues tab dedicated to guides issues only, <strong>no personal hackintosh issues</strong>. It is not a place to discuss installation issues.</li>
|
|
<li>If for a typo or better clarification, please indicate what page it was on. Would appreciate not going for a scavenger hunt on where these issues are.</li>
|
|
</ul>
|
|
<p>You can find the issues tab here: <a href="https://github.com/dortania/Getting-Started-With-ACPI/issues" target="_blank">Getting Started With ACPI Issues</a></p>
|
|
<h2 id="contributing-via-prs"><a name="contributing-via-prs" class="plugin-anchor" href="#contributing-via-prs"><i class="fa fa-link" aria-hidden="true"></i></a>Contributing via PRs</h2>
|
|
<p>Some guidelines when contributing via PRs:</p>
|
|
<ul>
|
|
<li>Use your brain (please).</li>
|
|
<li>Proofread your submissions.</li>
|
|
<li>Pull Requests can be denied if we feel it does not fit or has inaccurate information. We will generally tell you why it is rejected though or ask for revisions.<ul>
|
|
<li>We would also appreciate sources for any bigger commits to make it easier on us to verify the info your provide is valid</li>
|
|
</ul>
|
|
</li>
|
|
<li>Images must be hosted locally in the repo under the <code>/images/</code> folder</li>
|
|
<li>Your PR must be run through a markdown lint and have all issues fixed.</li>
|
|
<li>In general, try to avoid using "non-Acidanthera" tools when possible. Generally we want to avoid use of third-party tools - though if it's impossible otherwise, then you can link it.<ul>
|
|
<li>Tools explicitly banned:<ul>
|
|
<li>UniBeast, MultiBeast and KextBeast<ul>
|
|
<li>More info can be found here: <a href="https://github.com/khronokernel/Tonymcx86-stance" target="_blank">Tonymacx86-stance</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>Transmac<ul>
|
|
<li>Know for creating borked USB drives</li>
|
|
</ul>
|
|
</li>
|
|
<li>Niresh Installers<ul>
|
|
<li>We'd like to avoid piracy with the guides</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="how-to-contribute"><a name="how-to-contribute" class="plugin-anchor" href="#how-to-contribute"><i class="fa fa-link" aria-hidden="true"></i></a>How to Contribute</h3>
|
|
<p>Best way to test your commits and make sure they are formatted correctly is downloading <code>nodejs</code> and getting the <a href="https://github.com/GitbookIO/gitbook-cli" target="_blank">gitbook-cli</a> and <a href="https://github.com/igorshubovych/markdownlint-cli" target="_blank">markdownlint-cli</a> tools. When you run <code>gitbook serve</code>, it will set up a local webserver which you can connect to view the changes you made. <code>markdownlint *</code> will throw any errors at you about formatting as well, and <code>markdownlint -f *</code> will attempt to fix these.</p>
|
|
<ul>
|
|
<li><a href="https://github.com/dortania/Getting-Started-With-ACPI/fork/" target="_blank">Fork this repo</a></li>
|
|
<li>Install the required tools:<ul>
|
|
<li><code>npm install -g markdownlint-cli</code></li>
|
|
<li><code>npm install -g gitbook-cli</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>Make your changes.</li>
|
|
<li>Build the site:<ul>
|
|
<li><code>gitbook install</code> (To install all the required gitbook plugins)</li>
|
|
<li><code>gitbook serve</code> (Preview the site)<ul>
|
|
<li>Can be found at <code>http://localhost:4000</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Check markdown format:<ul>
|
|
<li><code>markdownlint -f *</code> (To fix any potential issues)</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="tips"><a name="tips" class="plugin-anchor" href="#tips"><i class="fa fa-link" aria-hidden="true"></i></a>Tips</h3>
|
|
<p>Some tools that make contributing a bit easier:</p>
|
|
<ul>
|
|
<li><a href="https://typora.io" target="_blank">Typora</a> for real time markdown rendering.</li>
|
|
<li><a href="https://macromates.com" target="_blank">TextMate</a> for easy and powerful mass find/replace.</li>
|
|
<li><a href="https://desktop.github.com" target="_blank">Github Desktop</a> for more user friendly GUI.</li>
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<a href="troubleshooting.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: Troubleshooting">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Contributing","level":"7.2","depth":1,"previous":{"title":"Troubleshooting","level":"7.1","depth":1,"path":"troubleshooting.md","ref":"troubleshooting.md","articles":[]},"dir":"ltr"},"config":{"plugins":["theme-default","-lunr","-search","search-plus","addcssjs","favicon-plus","anchors","github-buttons","last-modified","medium-zoom"],"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"},"pluginsConfig":{"last-modified":{},"output":"_book","intopic-toc":{"label":"Navigation"},"addcssjs":{"css":[],"js":[]},"medium-zoom":{},"fontsettings":{"theme":"night","family":"sans","size":2},"favicon-plus":{"appleTouchIconPrecomposed152":"","favicon":"","output":"_book"},"highlight":{},"github-edit":{"repo":"dortania/Getting-Started-With-ACPI","branch":"master"},"favicon":"/icons/favicon.ico","appleTouchIconPrecomposed152":"/icons/appleTouchIconPrecomposed152.png","github-buttons":{"buttons":[{"user":"dortania","repo":"Getting-Started-With-ACPI","type":"star","size":"large"}]},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":[]},"theme-default":{"showLevel":false,"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}},"anchors":{},"search-plus":{}},"theme":"default","medium-zoom":{"margin":24,"background":"#363b40","scrollOffset":0},"pdf":{"pageBreaksBefore":"/","headerTemplate":null,"paperSize":"a4","margin":{"right":62,"left":62,"top":36,"bottom":36},"fontSize":12,"fontFamily":"Arial","footerTemplate":null,"chapterMark":"pagebreak","pageNumbers":false},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"links":{"sharing":{"google":false,"facebook":false,"twitter":false,"weibo":false,"all":false}},"gitbook":"*"},"file":{"path":"CONTRIBUTING.md","mtime":"2020-05-01T17:13:02.016Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-05-01T17:13:57.280Z"},"basePath":".","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook.js"></script>
|
|
<script src="gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-search-plus/jquery.mark.min.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-search-plus/search.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-github-buttons/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-medium-zoom/medium-zoom.min.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-medium-zoom/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|