[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/gited 046dffd 20/73: Update documentation
From: |
Stefan Monnier |
Subject: |
[elpa] externals/gited 046dffd 20/73: Update documentation |
Date: |
Sun, 29 Nov 2020 00:00:31 -0500 (EST) |
branch: externals/gited
commit 046dffd9a2a8f52c029e5e1a37d9b8744a45d9d8
Author: Tino Calancha <tino.calancha@gmail.com>
Commit: Tino Calancha <tino.calancha@gmail.com>
Update documentation
* gited.el: Add Bugs/TODO section and URL header. Update comentary section.
* README.md: Add simple example.
---
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
gited.el | 4 ++--
2 files changed, 46 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 5a72246..8909f6c 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,47 @@ Gited; that's because most of the Gited commands with a
Dired equivalent
share same keybindings.
For instance *gited-rename-branch* is bound to 'R' as *dired-do-rename*.
Similarly, *gited-mark* is bound to 'm' as *dired-mark*.
+
+## How to push to the remote repo. your local changes
+
+Suppose you want to update a file *foo* (*).
+
+From the Gited buffer:
+
+```
+c master RET ; Checkout master branch (**).
+*< ; Synchronize with remote repository.
+```
+
+Now, update *foo* with your changes and save it.
+
+From the Gited buffer:
+
+```
+A ; Stage your changes.
+```
+
+```
+C-c c "Updated foo" RET ; Commit them.
+```
+
+```
+*> ; Public your changes into the remote repository.
+```
+
+---
+(*) We have restricted to 1 file for simplicity. The recipe works
+ for N>=1 files.
+
+(**) For changes that require several commits you might prefer to
+ work in a separated branch 'feature'. In that case you'd
+ merge the master branch with 'feature' before ```*>```).
+
+
+### Bugs/TODO
+
+* Currently, *origin* is assumed as the remote repository:
+ Remove some hardcode *origin* around, and extend it
+ to handle multiple remotes.
+
+* Pull requests are not implemented.
diff --git a/gited.el b/gited.el
index 85540c4..0c1e927 100644
--- a/gited.el
+++ b/gited.el
@@ -10,9 +10,9 @@
;; Compatibility: GNU Emacs: 24.4
;; Version: 0.2.0
;; Package-Requires: ((emacs "24.4") (cl-lib "0.5"))
-;; Last-Updated: Thu Jun 08 22:31:32 JST 2017
+;; Last-Updated: Fri Jun 09 20:41:14 JST 2017
;; By: calancha
-;; Update #: 652
+;; Update #: 653
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
- [elpa] externals/gited 84a449a 15/73: * gited.el (gited--fill-branch-alist): Fix typo in progress reporter., (continued)
- [elpa] externals/gited 84a449a 15/73: * gited.el (gited--fill-branch-alist): Fix typo in progress reporter., Stefan Monnier, 2020/11/29
- [elpa] externals/gited 00ef7a4 16/73: * gited.el (gited-move-to-branchname): NOOP when gited-branch-alist is nil., Stefan Monnier, 2020/11/29
- [elpa] externals/gited 3aa8b40 07/73: Mark branches by last commit time, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 75e0556 08/73: Don't ask deletion confirmation when gited-expert is non-nil, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 0be4308 12/73: Prefer user-error on errors with origin in the user, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 44498a6 22/73: Add commands to add/delete tags, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 37fe689 25/73: * gited.el (gited--fill-branch-alist): Silence harmless warning., Stefan Monnier, 2020/11/29
- [elpa] externals/gited d26d8c4 11/73: Simplify code using gited-branch-exists-p, Stefan Monnier, 2020/11/29
- [elpa] externals/gited d928e5f 29/73: * screenshots/gited-tags-screenshot.png: Update screenshot., Stefan Monnier, 2020/11/29
- [elpa] externals/gited 790c20c 09/73: gited-mark-branches-by-date: Use less verbose default, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 046dffd 20/73: Update documentation,
Stefan Monnier <=
- [elpa] externals/gited 5f57f01 21/73: * gited.el (gited-mode-map): Use prefix '* s' for all stash commands., Stefan Monnier, 2020/11/29
- [elpa] externals/gited 8db1633 04/73: gited-update: Don't overwrite `tabulated-list-sort-key', Stefan Monnier, 2020/11/29
- [elpa] externals/gited 5138dee 01/73: Add new library gited.el, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 9989d95 05/73: Fix sort of columns when gited-hide-details-mode is enabled, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 861281e 06/73: * gited.el (gited-mark-branches-regexp): Fix docstring., Stefan Monnier, 2020/11/29
- [elpa] externals/gited eeadd65 26/73: Add missing docstrings for several commands, Stefan Monnier, 2020/11/29
- [elpa] externals/gited 239ac36 31/73: * gited.el: Bump version to 0.2.3., Stefan Monnier, 2020/11/29
- [elpa] externals/gited fd28d69 48/73: * gited-tests.el (gited-test1): Use gited--last-commit-title., Stefan Monnier, 2020/11/29
- [elpa] externals/gited 09c79b9 64/73: Separate versions from file names with --, Stefan Monnier, 2020/11/29
- [elpa] externals/gited ed83468 59/73: * packages/gited/gited.el: Bump version to v5.0.1, Stefan Monnier, 2020/11/29