Skip to content

Commit

Permalink
docs: update mobile warning and gitignore fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinzent03 committed Feb 8, 2024
1 parent 5219c26 commit 54f7a42
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 10 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ Please use AppImage instead ([Linux installation guide](https://publish.obsidian

## Mobile

Installation and Getting Started can be found in the [documentation](https://publish.obsidian.md/git-doc/Getting+Started#Mobile).
The git implementation on mobile is **very unstable**!

### Restrictions of the mobile version
### Restrictions

I am using [isomorphic-git](https://isomorphic-git.org/), which is a re-implementation of Git in JavaScript, because you cannot use native Git on Android or iOS.

Expand All @@ -86,8 +86,14 @@ I am using [isomorphic-git](https://isomorphic-git.org/), which is a re-implemen

### Performance on mobile

> **Warning**
> Depending on your device and available free RAM, Obsidian may crash on clone/pull. I don't know how to fix this. If that's the case for you, I have to admit this plugin won't work for you. So commenting on any issue or creating a new one won't help. I am sorry.
> [!caution]
> Depending on your device and available free RAM, Obsidian may
>
> - crash on clone/pull
> - create buffer overflow errors
> - run indefinitely.
>
> It's caused by the underlying git implementation on mobile, which is not efficient. I don't know how to fix this. If that's the case for you, I have to admit this plugin won't work for you. So commenting on any issue or creating a new one won't help. I am sorry.
**Setup:** iPad Pro M1 with a [repo](https://github.com/Vinzent03/obsidian-git-stress-test) of 3000 files reduced from [10000 markdown files](https://github.com/Zettelkasten-Method/10000-markdown-files)

Expand Down
15 changes: 13 additions & 2 deletions docs/Common issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ Run `which git` in the terminal. It should return the path to the Git executable

That's most time caused by authentication problems. Head over to [[Authentication]]

## Bad owner or permissions on /home/<user>/.ssh/config
## Bad owner or permissions on /home/\<user>/.ssh/config

Run `chmod 600 ~/.ssh/config` in the terminal.
Run `chmod 600 ~/.ssh/config` in the terminal.


## Files in `.gitignore` aren't ignored

Since the plugin uses the native git installation, I can assure you that if the `.gitignore` file is properly written and git is correctly used, everything should work.

It's important to note that once a file is committed (or staged) changing the `.gitignroe` doesn't help. You have to delete the file from your repo manually to ignore the file properly:
1. Run `git rm --cached <file>` in your terminal. The file will stay on your file system. It's just deleted in your repo.
2. The file should be listed as deleted in `git status`
3. Commit the deletion
4. Now any changes to the file are properly ignored.
14 changes: 10 additions & 4 deletions docs/Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ To clone, you have to use a remote URL. This can be one of two protocols: either
4. Read on how to best configure your [[Tips-and-Tricks#Gitignore|.gitignore]]

# Mobile
The git implementation on mobile is **very unstable**!

## Performance and restrictions
## Restrictions

I am using [isomorphic-git](https://isomorphic-git.org/), which is a re-implementation of Git in JavaScript, because you cannot use native Git on Android or iOS.

Expand All @@ -26,10 +27,15 @@ I am using [isomorphic-git](https://isomorphic-git.org/), which is a re-implemen
- Rebase merge strategy is not supported
- Submodules are not supported

### Performance on mobile
## Performance on mobile

> [!Warning]
> Depending on your device and available free RAM, Obsidian may crash on clone/pull. I don't know how to fix this. If that's the case for you, I have to admit this plugin won't work for you. So commenting on any issue or creating a new one won't help. I am sorry.
> [!danger] Warning
> Depending on your device and available free RAM, Obsidian may
> - crash on clone/pull
> - create buffer overflow errors
> - run indefinitely.
>
> It's caused by the underlying git implementation on mobile, which is not efficient. I don't know how to fix this. If that's the case for you, I have to admit this plugin won't work for you. So commenting on any issue or creating a new one won't help. I am sorry.
## Start with existing remote repository

Expand Down
2 changes: 2 additions & 0 deletions docs/Start here.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ aliases:
> Please don't use Flatpak or Snap to install Obsidian on Linux. Learn more [[Installation#Linux|here]]

![[Getting Started#Performance on mobile]]

## What is Git?

Git is a version control system. It allows you to keep track of changes to your notes and revert back to previous versions. It also allows you to collaborate with other people on the same files. You can read more about Git [here](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control).
Expand Down

0 comments on commit 54f7a42

Please sign in to comment.