Differences

This shows you the differences between two versions of the page.

--- contributing-to-batocera [2022/01/20 00:27] – added info about commits and how they're a required step in the whole process, amended false PR information, adjusted inlinks atari
+++ contributing-to-batocera [2022/01/30 04:26] (current) – [Making changes in the future] a bit less contradictory phrasing atari
@@ Line 101: / Line 101: @@
 It is important to distinguish between remote and local repositories. Right now, your account has a remote repository that is a fork (copy) of Batocera.linux. We need to clone (download) this origin remote repository to your local computer to be able to make local edits to it.
-The easiest way is to open a command line, navigate to the directory you would like to save the origin repository to and run ''%%git clone https://github.com/<your Github username>/batocera.linux%%''.
+The easiest way is to open a command line, navigate to the directory you would like to save the origin repository to and run:
+<code bash>
+git clone https://github.com/<your Github username>/batocera.linux
+</code>
 Once done (this may take a while, depending on your internet speed), run the following:
-  * ''cd batocera.linux''
-  * ''%%git remote add upstream https://github.com/batocera-linux/batocera.linux.git%%''
+<code bash>
-  * ''%%git remote set-url upstream https://github.com/batocera-linux/batocera.linux.git%%''
+cd batocera.linux
-  * ''%%git remote set-url origin https://github.com/YOURNAME/batocera.linux%%'' where ''YOURNAME'' is your Github username.
+git remote add upstream https://github.com/batocera-linux/batocera.linux.git
+git remote set-url upstream https://github.com/batocera-linux/batocera.linux.git
+git remote set-url origin https://github.com/<your Github username>/batocera.linux
+</code>
+where ''<your Github username>'' is your Github username (remove the "<>" characters).
 This will config the local repository to be recognized as a fork of upstream (the original remote repository). This makes it easier to stay "in sync" with future changes made to upstream.
+Submodules (such as buildroot) will become outdated over time. Run the following to set them up to update along with the main repository:
+<code bash>
+git submodule init
+git submodule update
+</code>
 ==== Create a local branch on your fork ====
@@ Line 127: / Line 143: @@
 ==== Making and testing the modifications ====
-You have some guidelines on [[:batocera.linux_buildroot_modifications|this page to compile individual packages]], a [[:notable_files|list of notable files and their location on a live install]] and [[:compile_batocera.linux|this page for more general compilation of the whole Batocera Linux system]].
+You have some guidelines:
+  * [[:coding_rules|The coding rules page for adding new scripts]]
+  * [[:notable_files|A list of notable files and their location on a live install]]
+  * [[:batocera.linux_buildroot_modifications|Compiling individual packages]]
+  * [[:compile_batocera.linux|The compiling Batocera page for more general compilation of the whole Batocera Linux system]]
 ==== Commit changes to the local branch ====
@@ Line 139: / Line 159: @@
 When all the commits have been committed, merge the commits from your local clone into your fork's repository with the following command (replacing the name of the branch with your own):
-<code>
+<code bash>
 git push --set-upstream origin name-of-the-branch
 </code>
@@ Line 165: / Line 185: @@
   - ''%%git fetch upstream%%'' : Tells git to grab every changes from the upstream repository
   - ''%%git rebase upstream/master%%'' : Tells git to make your branch up to date with the master branch of the upstream repository
+  - (Optional) ''%%git push%%'' : Pushes the latest commits to **your fork's** remote repository.
-<WRAP center round info>
+<WRAP center round tip>
-It is not recommended to use ''%%git pull upstream master%%''. [[https://longair.net/blog/2009/04/16/git-fetch-and-merge/|Here's a good blog post about it.]]
+You can create an alias for these commands by executing the following:
+<code bash>
+git config --global alias.update '!git checkout master && git fetch upstream && git rebase upstream/master && git push'
+</code>
+This way, running ''git update'' will execute all the commands required to sync up your local and remote master branch with batocera.linux's master branch.
 </WRAP>
 Then repeat the steps from the [[#create_a_local_branch_on_your_fork|"Create a new local branch on your fork"]] section above.
+<WRAP center round info>
+Performing fetches and merges manually instead of relying on aliases can be quite powerful. [[https://longair.net/blog/2009/04/16/git-fetch-and-merge/|Here's a good blog post about it.]]
+</WRAP>
+<WRAP center round tip>
+As you create new changes and successfully complete PRs, branches can start piling up on your cloned fork.
+You can remove old branches from your cloned repository by first switching to the appropriate branch (''git checkout name-of-branch'' if not already on it) and then running ''git branch -d'' when you are done with them and the pull request has since been closed.
+</WRAP>
+===== Tips =====
+==== Check all the current differences ====
+This will just show the differences in the files between now and the last commit. This is not a reflection of all the differences between the branch and the master branch.
+<code bash>
+git diff
+</code>
+==== Discard all changes ====
+This restores files back from the last commit. First, ensure you are on the branch you intend to undo the changes on, and run the following:
+<code bash>
+git restore .
+</code>
+Individual files can also be specified by replacing ''.''.
+===== Troubleshooting =====
+==== There are changes to the buildroot submodule that I didn't make! ====
+That's why you updated the submodules earlier. But this can also happen if you say download a branch from the remote that hasn't had the submodules updated yet. To update the submodules again run the following:
+<code bash>
+git submodule update
+</code>