Skip to content

Commit

Permalink
Change style for MD029 from one to ordered (lra#1872)
Browse files Browse the repository at this point in the history
  • Loading branch information
hezhizhen authored Oct 20, 2022
1 parent 0837599 commit 0d778aa
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 26 deletions.
4 changes: 4 additions & 0 deletions .mdl_style.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
all
rule 'MD007', :indent => 2
rule 'MD029', :style => :ordered
exclude_rule 'MD041'
1 change: 1 addition & 0 deletions .mdlrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
style './.mdl_style.rb'
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
There are 2 ways to run mackup

1. Install it with Homebrew (OSX only)
1. Install it with PIP (OSX and GNU/Linux)
2. Install it with PIP (OSX and GNU/Linux)

## Install

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,8 @@ folder, in the `.gitconfig` file.
If you have Dropbox, these things happen when you launch `mackup backup`:

1. `cp ~/.gitconfig ~/Dropbox/Mackup/.gitconfig`
1. `rm ~/.gitconfig`
1. `ln -s ~/Dropbox/Mackup/.gitconfig ~/.gitconfig`
2. `rm ~/.gitconfig`
3. `ln -s ~/Dropbox/Mackup/.gitconfig ~/.gitconfig`

Now your `git` config is always backed up and up to date on all your workstations.

Expand Down
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,9 @@ If you ever change your mind and switch storage solutions after Mackup is
already setup (ex: from `dropbox` to `icloud`), complete the following steps.

1. Run `mackup uninstall` on all computers
1. Copy your Mackup files to the new storage location
1. Change the storage provider details in your `.mackup.cfg` file (see above)
1. Run `mackup backup` on the main computer and `mackup restore` on all others
2. Copy your Mackup files to the new storage location
3. Change the storage provider details in your `.mackup.cfg` file (see above)
4. Run `mackup backup` on the main computer and `mackup restore` on all others

## Applications

Expand Down
22 changes: 11 additions & 11 deletions doc/configuration_merge_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ First, pick the app you wish to keep in sync. Then determine which
configuration files will be synced for that application by doing the following:

1. [Install Mackup](./../INSTALL.md)
1. Create a `.mackup.cfg` file in your home directory
1. Add the following two lines to `.mackup.cfg`. Replace **bash**
2. Create a `.mackup.cfg` file in your home directory
3. Add the following two lines to `.mackup.cfg`. Replace **bash**
in the example below with the name of your application.

```
```text
[applications_to_sync]
bash
```

You can get a list of supported apps by running `mackup list`.

1. Save the file
1. Run the following command:
2. Run the following command:

`mackup --dry-run --verbose backup`

Expand Down Expand Up @@ -64,9 +64,9 @@ from other machines.

1. Create a backup of each machine's configuration files for the app you wish
to sync.
1. Choose a machine that will serve as the initial "master". It doesn't really
2. Choose a machine that will serve as the initial "master". It doesn't really
matter which one.
1. Edit your configuration files on the master machine so that they
3. Edit your configuration files on the master machine so that they
represent the ideal version of the file you wish to distribute out to your
other machines.

Expand All @@ -80,7 +80,7 @@ for your application on all machines.

##### Sample backup commands for Machine A**

```
```bash
mkdir ~/bash_backup
cp ~/.bash_profile ~/bash_backup/bash_profile.bak
cp ~/.bash_login ~/bash_backup/bash_login.bak
Expand All @@ -90,7 +90,7 @@ cp ~/.bash_login ~/bash_backup/bash_login.bak

##### Sample backup commands for Machine B

```
```bash
mkdir ~/bash_backup
cp ~/.bash_profile ~/bash_backup/bash_profile.bak
cp ~/.bash_login ~/bash_backup/bash_login.bak
Expand All @@ -102,7 +102,7 @@ Machine A will be our master so we now edit the existing configuration files
on Machine A. We will use the vim text editor to do this for each of our
configuration files:

```
```bash
vim .bash_profile
vim .bash_login
```
Expand All @@ -118,7 +118,7 @@ from the master machine.
1. Choose a machine that will serve as the initial "master". You'll probably
want to use choose the machine you use most and like its configuration
settings the best.
1. For each machine that aren't the "master" (i.e. "slaves"), back up all the
2. For each machine that aren't the "master" (i.e. "slaves"), back up all the
configuration files for each app that you want to sync. That's it for now.
However, there will be more work for you later.

Expand All @@ -132,7 +132,7 @@ Machine B:

##### Sample backup commands for Machine B**

```
```bash
mkdir ~/bash_backup
cp ~/.bash_profile ~/bash_backup/bash_profile.bak
cp ~/.bash_login ~/bash_backup/bash_login.bak
Expand Down
14 changes: 7 additions & 7 deletions doc/release.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Release

1. Move all the WIP changes under a new version in the [changelog](../CHANGELOG.md)
1. Increment the version in [constants.py](../mackup/constants.py)
1. `git commit` with the message `Mackup X.Y.Z`
1. `git tag <version>`
1. `git push`
1. `git push --tags`
1. `make release`
1. Move all the WIP changes under a new version in the [changelog](../CHANGELOG.md)
2. Increment the version in [constants.py](../mackup/constants.py)
3. `git commit` with the message `Mackup X.Y.Z`
4. `git tag <version>`
5. `git push`
6. `git push --tags`
7. `make release`
2 changes: 1 addition & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ pipenv run make test

And you should see

```
```text
.
----------------------------------------------------------------------
Ran 1 test in 0.016s
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Blank file for git sync
Blank file for git sync

0 comments on commit 0d778aa

Please sign in to comment.