From 8af07f0d6f492f076ddbc3dd0bd702543f55242d Mon Sep 17 00:00:00 2001 From: Sergei Vorobev Date: Wed, 6 Jul 2016 20:37:12 -0700 Subject: [PATCH] Remove out-dated git documentation --- docs/git/committing.md | 58 ---------------------------------------- docs/git/source-depot.md | 52 ----------------------------------- 2 files changed, 110 deletions(-) delete mode 100644 docs/git/committing.md delete mode 100644 docs/git/source-depot.md diff --git a/docs/git/committing.md b/docs/git/committing.md deleted file mode 100644 index 3d3373f2bf..0000000000 --- a/docs/git/committing.md +++ /dev/null @@ -1,58 +0,0 @@ -Commit Dance -============ - -This process only applies to `src/Modules/Pester`. -If you need to touch their content, this doc -provides the overview of the process. Remember that it's written -against `src/monad` submodule, which doesn't exist anymore. - -Also see the [submodules documentation](./submodules.md). - -Sometimes, you need to do the work in a submodule (i.e. you added a new string in `.resx` file). -The submodule has a relationship to the SuperProject (PowerShell), but in order to be sure that CI is -notified about changes in a submodule, you need be sure that this is reflected as a pull request in the SuperProject. - -**Scenario**: Jim fixes issue in `src/monad/monad/src/engine/DataStoreAdapter.cs` - -the following takes place in the submodule: -* Make the code change -* Commit the code change in a feature branch. Branch name in form `/`, i.e `jim/colon-drive`. -* Push the branch (in the submodule project): `git push origin jim/colon-drive` -* Pull request in the submodule to notify people via email about new code review. - -Then, in the SuperProject (PowerShell) -* `git status` should show a change of submodule **as a whole** (not individual files). _In my case_ it is `src/monad`. -* `git diff` should show something like - -```diff -index 1ba8dd4..ed5d202 160000 ---- a/src/monad -+++ b/src/monad -@@ -1 +1 @@ --Subproject commit 1ba8dd4f721f2cd4363f64609515ec1600378c30 -+Subproject commit ed5d2022617f317a78a8a57e2c257c8e29cddbd5 -``` - -* Commit that change into a branch with the same name, i.e. `jim/colon-drive` -* Push the branch (in the SuperProject): `git push origin jim/colon-drive` -* Pull request in the superproject to kick-in CI build and notify people. Reference submodule pull-request in the PR message to make navigation between two simpler. - -Commands log ------------- - -Here is a transcript of command Jim used: -```sh -cd $HOME/PowerShell/src/monad/monad/src/engine -vi DataStoreAdapter.cs -git checkout -b jim/colon-drive -git commit -a -git push origin jim/colon-drive -``` -then I went to the web interface and did the pull request *in the submodule*. After that, back to the commandline: -```sh -cd $HOME/PowerShell -git checkout -b jim/colon-drive -git commit -a -git push origin jim/colon-drive -``` -and back to the web interface for the pull request *in the superproject*. diff --git a/docs/git/source-depot.md b/docs/git/source-depot.md deleted file mode 100644 index 41c1fcc3bd..0000000000 --- a/docs/git/source-depot.md +++ /dev/null @@ -1,52 +0,0 @@ -# Quick git-primer for sd users - -There few important conceptual differences with **sd**. -This list tries to bridge the gap - -* When you do `git commit` changes are stored in your local clone of the repo. -To Submit them, you need to do `git push`. -* Forks are just a way to store branches. -You can push branch to the original repo (if you have permissions) or to the fork. -There is no principal difference. -* Most of the git complications come from the fact that you need to do integrations by yourself. - - -The Microsoft Open Source Hub [article](https://opensourcehub.microsoft.com/articles/git-for-sd-users) for other details. - -### Rosetta stone - - -#### Concepts - -| Concept | SD termin | Git termin | -|---------|----|----------------| -| Your local copy | enlistment | cloned repo | -| Code changes | changelist | commit | -| Way to preserve changes locally | dpk | local branch | - - -#### Commands - -Before running a git command for the first time, try - -```sh -git help -``` - -To read about flags and the overall meaning. - -|Scenarios | SD command | Git commmand | -|---------|----|----------------| -| Get the code at the first place | sd enlist | git clone | -| Sync changes | sd sync | git pull | -| Add new files | sd add | git add | -| Modify existing files | sd edit | git add | -| Remove existing files | sd delete | git rm | -| Copy/Rename files | sd branch | git mv | -| Commit to local | | git commit | -| Submit changes | sd submit | git push | -| Revert changes | sd revert | git checkout | -| Undo submitted changes | sd undo | git revert | -| Diff tool | odd | git diff | -| Clean enlistment | build nuke | git clean | -