public
/
ensync
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc updated.

Browse Source
pull/1/head
Ivan Olexyn 5 years ago
parent a208653312
commit d5530fbe09
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File

25
README.md
Unescape View File

@ -14,21 +14,24 @@ Sync files across directories.
### Package Contents <a name="package-contents"></a> ### Package Contents <a name="package-contents"></a>
| File | Description | | Path | Comment |
|---------------|-------------| |---------------|-------------|
| artifacts/SyncDirectory | A directory that is registered to a SyncEntity.| doc | Diagrams.
| artifacts/SyncEntity | A collection of directories that are being syncronized.| src.com.olexyn.ensync.artifacts | Data Model: Maps, Directories, Files.
| shell/ | Contains .sh files | src.com.olexyn.ensync.shell | .sh files to ease interaction with the host.
| Execute | Issues sh commands.| src.com.olexyn.ensync.ui | JavaFX.
| Main | Run from here.| src.com.olexyn.ensync.Execute | Issue .sh commands.
| Routines | Contains higher level routines.| src.com.olexyn.ensync.Main | Run from here.
| Tools | Contains lower level tools that are used by other classes.| src.com.olexyn.ensync.Flow | Flow of the synchronization.
src.com.olexyn.ensync. | Low level helper methods.
<br> <br>
<br> <br>
### Issues <a name="issues"></a> ### Issues <a name="issues"></a>
##### High Prio
- Have Map entries be remove, once file ops is performed. - Have Map entries be remove, once file ops is performed.
- Create a parallel Thread for each SyncEnity. - Create a parallel Thread for each SyncEnity.
- Add support for modification dates. - Add support for modification dates.
@ -46,6 +49,9 @@ Sync files across directories.
- thus the creation of said file will not be replicated to the other directories. - thus the creation of said file will not be replicated to the other directories.
- to solve this `writeStateFile` should take the old `State` and manually add every operation that was performed by the loop (!= user created file while the loop was running). - to solve this `writeStateFile` should take the old `State` and manually add every operation that was performed by the loop (!= user created file while the loop was running).
- however this will be done later . . maybe. - however this will be done later . . maybe.
##### Medium Prio
- If file is deleted in DirA and DirB, then two delete commands will be issued. - If file is deleted in DirA and DirB, then two delete commands will be issued.
- They will both return errors and effectively do nothing. - They will both return errors and effectively do nothing.
- However this is a dirty solution. - However this is a dirty solution.
@ -58,3 +64,6 @@ Sync files across directories.
- Sync creates the file in DirB - Sync creates the file in DirB
- this means the file in DirB is overwritten with `cp` for no reason. - this means the file in DirB is overwritten with `cp` for no reason.
- implement a check to prevent this. - implement a check to prevent this.
##### Low Prio
Write Preview
Loading…
Cancel
Save