26
edits
Geometry package:GSoC17: Difference between revisions
→Workplan
PiyushJain (talk | contribs) |
PiyushJain (talk | contribs) |
||
| Line 58: | Line 58: | ||
1. Handling '''overlapping edges''' seems to be a bit tedious with this algorithm. It will surely be a challenge. | 1. Handling '''overlapping edges''' seems to be a bit tedious with this algorithm. It will surely be a challenge. | ||
===Syncing matGeom and geometry=== | |||
The goal is to devise a somewhat automated way to ensure that the functions which are there in geometry are synced with those in matGeom without manually checking the edits. | |||
To achieve this, first a workaround is implemented on a dummy repository [https://github.com/piyush-jain1/dummyMatGeom/ dummyMatGeom]. Its master branch is matGeom (dummy) and there is another branch (named geometry) is created which contains geometry package (dummy). Lets assume that local directory of matGeom is named as dummyMatGeom and local directory of geometry is dummyGeom. Then, follow these steps : | |||
1. go to the local dummyMatGeom directory and pull upstream (dummy matGeom) using these commands : | |||
- git fetch origin master | |||
- git reset --hard FETCH_HEAD | |||
- git clean -df | |||
This will ensure that your local repo is exactly same as your current version of matGeom. Here, we are doing hard reset because when we apply folder structure change script (next step), it might have changed its structure. | |||
2. run the following octave command. | |||
- rmdir("dummyGeom/deprecated","s"); | |||
- movefile("dummyMatGeom/matGeom/deprecated","dummyGeom/"); | |||
- movefile("dummyMatGeom/matGeom", "dummyGeom/"); | |||
- rmdir("dummyGeom/inst","s"); | |||
- rename("dummyGeom/matGeom","dummyGeom/inst"); | |||
This will simply replace the scripts of geometry with those of matGeom. Don't worry, we are not going to push this whole matGeom script folder onto our geometry repo.We'll now commit and push only those scripts which have been modified and the rest of scripts will remain as it is, in the remote repository(geometry branch). | |||
3. Now, go to local geometry directory (dummyGeom) and run following command. | |||
- git diff --name-only --diff-filter=M | xargs git add | |||
- git commit -m "synced with matGeom" | |||
- git push origin master:geometry | |||
This will sync the scripts which were already present in the geometry branch with those of the matGeom branch without disturbing other scripts. | |||
4. Now, update your local geometry repo by force pulling from the remote branch. | |||
- git pull -f origin master:geometry | |||
* '''Challenges : ''' | |||
Clearly, the above procedure will only sync the script of the function, not it's tests and demo, which are in separate folders in a Matlab package structure. Even if we try to concatenate their corresponding test/demo scripts with the function scripts (as it is in an octave package structure), there will be discrepancies because the notion or writing tests for octave and matlab packages are quite different. The way octave allows tests to work is unique to octave as explained [http://wiki.octave.org/FAQ#What_features_are_unique_to_Octave.3F here]. SO, we can't simply concatenate the Matlab test scripts with the functions. | |||
=== Discoveries === | === Discoveries === | ||