expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2025-12-09 07:14:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

add warning about rsync on git repos - online edit of handbook/computing/winlaptop.html

Browse Source
This commit is contained in:
Philip Sargent
2025-06-23 08:24:42 +01:00
committed by Expo on server
parent ab26524ee4
commit e8f3526967
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
handbook/computing/winlaptop.html
View File

@@ -133,7 +133,7 @@ to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-
<h4>Configuring git</h4>
<p><a href="/expofiles/documents/Idiots guide to accessing expo git.pdf">Idiots guide to setting up git for expo</a>
- PDF - Brendan's guide. Uses puTTY and GitKraken on WIndows. Read this, but most people will need to use VS Code instead of Git Kraken.
- PDF - Brendan's guide. Uses puTTY and GitKraken on Windows. Read this, but most people will need to use VS Code instead of Git Kraken.
<p>Some software, such as the commercial (but free) GitKraken, requires that you click a checkbox to say that you are "using local SSH agent" rather than specifying ssh private keys explicitly (File->Preferences->Authentication in GitKraken).
@@ -141,31 +141,32 @@ to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-
<h3 id="process">The complete process sequence</h3>
<p>Whatever software you use, this is the procedure you need to follow.
<ol>
<li>Get the files you are going to edit onto your personal device (using scp, filezilla or git)
<li>Get the files you are going to edit onto your personal device (using scp, filezilla or git; or even wget or curl)
<li>Edit the files on your device
<li>either
<ul>
<li>git add the files to your local git repo
<li>git commit -m "this is my edit, I changed..."
<li>git push<br>
which will upload your edited file and also register it in ther version control system on the server
which will upload your edited file and also register it in the version control system on the server
</ul>
<li>or
<ul>
<li>upload the edited file with scp or filezilla
<li>login to the server using ssh (or putty on Windows)
<li>login to the server using ssh (or PuTTY on Windows)
<li><em>on the server:</em>:
<ul>
<li>cd expoweb (if editing handbook), or cd loser (if editing survex files), or cd drawings (if editing drawings) - wherever you uploaded the files to
<li>git add the files to the server git repo
<li>git commit -m "this is my edit, I changed..., my name is [Inigo Montoya]"
<br>
which will register your edited file in thee version control system on the server. <br>This is VITAL otherwise all the online forms that attempt to upload files for ordinary (non-bulk update) users will fail because the got repo you have uploaded to is not in he expected state.
which will register your edited file in thee version control system on the server.
<li>This is all VITAL otherwise all the online forms that attempt to upload files for ordinary (non-bulk update) users will fail because the got repo you have uploaded to is not in he expected state.
</ul>
</ul></ol>
<p>Note that the <var>:drawings:</var> repo also contains all the wallets configurations for all years, so if you screw up the drawings repo state, none of the online wallets updating stuff will work.
<p>Note that the <var>:drawings:</var> repo also contains all the wallets' configurations for all years, so if you screw up the drawings repo state, none of the online wallets updating stuff will work.
<h3 id="problems">Things that cause problems</h3>
<h4>git state incompletely tidied up</h4>
@@ -184,7 +185,7 @@ The links you are most likely to come across are that what looks like
and that
<span style="font-family:monospace; size=x-small; background-color: lightgray">expoweb/essentials.gpx</span>
is a link to the file <span style="font-family:monospace; size=x-small; background-color: lightgray">/home/expo/expofiles/gpslogs/essentials/essentials2019.gpx</span>
<p>But that example is in the <span style="font-family:monospace; size=x-small; background-color: lightgray">:expoweb:</span> repository, so you won't be using sFTP to download it. Instead you will be using the version control software which handles it without problems. But we use it as an example of what to look out for when using sFTP.
<p>But that example is in the <var>:expoweb:</var> repository, so you won't be using sFTP to download it. Instead you will be using the version control software which handles it without problems. But we use it as an example of what to look out for when using sFTP.
<p>
<img src="fzlink.jpg" align="right">
@@ -218,7 +219,8 @@ it downloads a <em>copy</em> of the contents of essentials.gpx and not a link.
<h2 id="rsync">Level 02 - Windows Bulk Synchronisation with rsync</h2>
<p>TLDR just don't do this: please.
<p>When using Windows please, please
<p>TLDR never, ever, under any circumstances, use rsync on any of the repos folders. <br>rsync should only ever be used for <var>expofiles/</var>
<p>When using Windows please, please
<ul>
<li>be <a href="../survey/getin.htm#filenames">excessively careful when naming files and survex names</a> and
<li>be <a href="qstart-rsync.html">exceptionally careful when using rsync</a>.