SVN Primer - Revision history

Philmasterplus: /* Specifications */

2021-03-13T07:07:31Z

Specifications

← Older revision		Revision as of 07:07, 13 March 2021
Line 103:		Line 103:
	When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.		When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

	'''Note''': If your relay override script uses images, place them under <code>images/relayimages/</code>. This is because KoLmafia serves images only if they are under <code>images/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98934]. However, the <code>cache clear</code> command will delete all files under <code>images/</code> except for the <code>images/relayimages/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98980].		'''Note''': If your [[Relay Override Scripting\|relay override script]] uses images, place them under <code>images/relayimages/</code>. This is because KoLmafia serves images only if they are under <code>images/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98934]. However, the <code>cache clear</code> command will delete all files under <code>images/</code> except for the <code>images/relayimages/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98980].

	==== Declaring Dependencies ====		==== Declaring Dependencies ====

Philmasterplus: /* Specifications */ Add info on images/relayimages/

2021-03-13T07:06:53Z

Specifications: Add info on images/relayimages/

← Older revision		Revision as of 07:06, 13 March 2021
Line 103:		Line 103:
	When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.		When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

	'''Note''': ~~Do not~~ place ~~your files in~~ <code>images/</code>. ~~The~~ <code>cache clear</code> command will delete all files under <code>images/</code>~~, including any files installed or created by your scripts!~~		'''Note''': If your relay override script uses images, place them under <code>images/relayimages/</code>. This is because KoLmafia serves images only if they are under <code>images/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98934]. However, the <code>cache clear</code> command will delete all files under <code>images/</code> except for the <code>images/relayimages/</code>[https://kolmafia.us/threads/performance-issues.13387/post-98980].

	==== Declaring Dependencies ====		==== Declaring Dependencies ====

Philmasterplus: Split info on dependencies to subsection, add warning about images/

2021-03-13T02:54:01Z

Split info on dependencies to subsection, add warning about images/

← Older revision		Revision as of 02:54, 13 March 2021
Line 87:		Line 87:
	=== Specifications ===		=== Specifications ===
	At the base level of the SVN link there are only several legal folders which may contain scripts:		At the base level of the SVN link there are only several legal folders which may contain scripts:
	* ccs/
	* data/		* <code>ccs/</code>
	* images/		* <code>data/</code>
	* planting/		* <code>images/</code> (see notes)
	* relay/		* <code>planting/</code>
	* scripts/		* <code>relay/</code>
			* <code>scripts/</code>

	Additionally there is only one legal file:		Additionally there is only one legal file:
	* dependencies.txt
	If there are any other folders or files at the base level of the SVN repository, it will ~~fail~~ to ~~be checked~~ out ~~by KoLmafia~~. This is a security feature. Within the stated folders you can nest any additional folders and files you desire.		* <code>dependencies.txt</code>

			If there are any other folders or files at the base level of the SVN repository, KoLmafia will refuse to check out the repository. This is a security feature. Within the stated folders you can nest any additional folders and files you desire.

	When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.		When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

	The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Each line in the file provides a url to another SVN project. Here is an example of what a dependencies.txt file may look like:		'''Note''': Do not place your files in <code>images/</code>. The <code>cache clear</code> command will delete all files under <code>images/</code>, including any files installed or created by your scripts!
	<~~nowiki~~> https://svn.code.sf.net/p/zlib/code
	https://svn.code.sf.net/p/smartstasis/code		==== Declaring Dependencies ====
	https://svn.code.sf.net/p/therazekolmafia/canadv/code/</~~nowiki~~>		The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Each line in the file provides a url to another SVN project. Here is an example of what a <code>'''dependencies.txt'''</code> file may look like:

			<pre>
			https://svn.code.sf.net/p/zlib/code
			https://svn.code.sf.net/p/smartstasis/code
			https://svn.code.sf.net/p/therazekolmafia/canadv/code/
			</pre>

	== How to Command SVN ==		== How to Command SVN ==

Bale: re-order

2016-12-19T21:40:05Z

re-order

@@ Line 36: / Line 36: @@
 Q. How does that work?<br />
 A. Black magic. Not really, but it is very impressive and you don't really need to know the mechanics. Just trust that it works.
 == Information for Scripters ==
@@ Line 109: / Line 132: @@
 * {{Flink|boolean|svn_at_head|string|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
 * {{Flink|record|svn_info|string|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}
 [[Category:New User Help]][[Category:Scripting]][[Category:Tech Support]]

Bale: /* Revision Merging */

2016-12-19T21:35:55Z

Revision Merging

← Older revision		Revision as of 21:35, 19 December 2016
Line 122:		Line 122:
	That's it! Now you can update from svn as usual. You can use <code> svn update bale-ocd </code> to update just that script, or <code> svn update </code> to update all your scripts or just check the box in SVN preferences to make it happen automatically once a day. Whenever the script is updated SVN will magically merge your changes into the working copy in the /svn folder and then push those changes into the local copy. This is magic! This will happen every single time you use svn to update the script without requiring your intervention. The CLI will display a "G" for merGing the script instead of a "U" for Updating it when this happens.		That's it! Now you can update from svn as usual. You can use <code> svn update bale-ocd </code> to update just that script, or <code> svn update </code> to update all your scripts or just check the box in SVN preferences to make it happen automatically once a day. Whenever the script is updated SVN will magically merge your changes into the working copy in the /svn folder and then push those changes into the local copy. This is magic! This will happen every single time you use svn to update the script without requiring your intervention. The CLI will display a "G" for merGing the script instead of a "U" for Updating it when this happens.

			=== Revision Conflicts ===
	If an update to a script changes it so severely that it cannot be merGed with your modifications, it will show "C" for Conflict and produce several files in the working copy to help you solve the problem:		If an update to a script changes it so severely that it cannot be merGed with your modifications, it will show "C" for Conflict and produce several files in the working copy to help you solve the problem:
	* myfile - will have some inline markup at the location of the conflict ( look for <<<<<< and >>>>> markup) showing you both what your text was and what the repo's text was.		* myfile - will have some inline markup at the location of the conflict ( look for <<<<<< and >>>>> markup) showing you both what your text was and what the repo's text was.

Bale at 01:18, 12 November 2014

2014-11-12T01:18:27Z

← Older revision		Revision as of 01:18, 12 November 2014
Line 115:		Line 115:
	The ''real'' awesome here is aimed at people who sometimes like to make small modifications to their scripts. People like you with a little bit of scripting ability. I suspect you've sometimes made a tiny tweak to a script to make it more perfect for your specific needs. Then the original author updates his script and you're stuck trying to decide if it is worth your trouble to copy all your modifications to the new version of his script. If not, you might just refuse to update it. With SVN if you know what you are doing, you can update your cake and eat it too! When svn updates your script it will automatically keep your modifications, producing a blend of your modifications and the author's update. Now I'll tell you how to do this.		The ''real'' awesome here is aimed at people who sometimes like to make small modifications to their scripts. People like you with a little bit of scripting ability. I suspect you've sometimes made a tiny tweak to a script to make it more perfect for your specific needs. Then the original author updates his script and you're stuck trying to decide if it is worth your trouble to copy all your modifications to the new version of his script. If not, you might just refuse to update it. With SVN if you know what you are doing, you can update your cake and eat it too! When svn updates your script it will automatically keep your modifications, producing a blend of your modifications and the author's update. Now I'll tell you how to do this.

	# Acquire the most recent version using svn update		# Acquire the most recent version using <code> svn update </code>
	# Open the script's working copy in the project's /svn directory, and make your edits. Always make sure the project in /svn has your changes		# Open the script's working copy in the project's /svn directory, and make your edits. Always make sure the project in /svn has your changes
	# Use the command <code> svn sync </code> to push your modifications in the working copy to the local copy in the /scripts or /relay directory		# Use the command <code> svn sync </code> to push your modifications in the working copy to the local copy in the /scripts or /relay directory

Bale: dependencies

2014-11-12T01:01:49Z

dependencies

← Older revision		Revision as of 01:01, 12 November 2014
Line 76:		Line 76:
	When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.		When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

	The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Here is an example of what a dependencies.txt file may look like:		The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Each line in the file provides a url to another SVN project. Here is an example of what a dependencies.txt file may look like:
	<nowiki> https://svn.code.sf.net/p/zlib/code		<nowiki> https://svn.code.sf.net/p/zlib/code
	https://svn.code.sf.net/p/smartstasis/code		https://svn.code.sf.net/p/smartstasis/code

Bale: add ash functions

2014-11-12T00:28:34Z

add ash functions

← Older revision		Revision as of 00:28, 12 November 2014
Line 20:		Line 20:
	'''Q. Why is SVN good for KoLmafia scripts?'''<br />		'''Q. Why is SVN good for KoLmafia scripts?'''<br />
	A. There are a whole bunch of reasons. I'll enumerate:		A. There are a whole bunch of reasons. I'll enumerate:
	# It makes script installation easier. The user doesn't have to ensure that the script is downloaded into the correct directory or ~~worry if there are~~ multiple files ~~to put~~ into multiple directories.		# It makes finding the script you want easy. Just read down the list checking the description for each.
			# It makes script installation easier. The user doesn't have to ensure that the script is downloaded into the correct directory or fret about putting multiple files into multiple directories.
	# It makes script updating easier. All scripts can be updated automatically at first run of the day, or the user can type <code> svn update </code> to manually update all scripts.		# It makes script updating easier. All scripts can be updated automatically at first run of the day, or the user can type <code> svn update </code> to manually update all scripts.
	# It is easier for the scripter to publish his scripts and keep them up to date.		# It is easier for the scripter to publish his scripts and keep them up to date.
Line 31:		Line 32:
	A. Yup. It's incomprehensible to most of us, but we've noticed that people hate reading our forum. Now you won't have to do that.		A. Yup. It's incomprehensible to most of us, but we've noticed that people hate reading our forum. Now you won't have to do that.

	'''Q. ~~That~~ sounds like black magic.'''<br />		'''Q. This sounds like black magic!'''<br />
	A. Please state your problem in the form of a question.<br />		A. Please state your problem in the form of a question.<br />
	Q. How does that work?<br />		Q. How does that work?<br />
Line 75:		Line 76:
	When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.		When the SVN repo is committed, the scripts in the folders will be pushed to local copies in corresponding folders in the KoLmafia directory. If there is a file of the same name in any of those folder, or a sub-folder of those folders, then the file will be copied to that location. This allows the user to move the files to new locations or sub-folders and still know that KoLmafia will keep it up to date.

	The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. Here is an example of what a dependencies.txt file may look like:		The file <code>'''dependencies.txt'''</code> contains a list of other SVN repositories that this script will automatically install. This is done so that the script can install other scripts it depends on. If there is a <code>'''dependencies.txt'''</code> file at the root directory of the repo, it will not be pushed along with the files in the various folders. It only exists to serve this purpose. Here is an example of what a dependencies.txt file may look like:
	<nowiki> https://svn.code.sf.net/p/zlib/code		<nowiki> https://svn.code.sf.net/p/zlib/code
	https://svn.code.sf.net/p/smartstasis/code		https://svn.code.sf.net/p/smartstasis/code
	https://svn.code.sf.net/p/therazekolmafia/canadv/code/</nowiki>		https://svn.code.sf.net/p/therazekolmafia/canadv/code/</nowiki>

	== SVN ~~Commands~~ ==		== How to Command SVN ==
	KoLmafia has both ASH and CLI commands to interact with SVN repos.		KoLmafia has both ASH and CLI commands to interact with SVN repos.
	=== CLI Commands ===		=== CLI Commands ===
Line 102:		Line 103:
	* <code>svn sync</code>		* <code>svn sync</code>
	: This looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the working copy file is copied over the local copy one. Note that this is very different from "svn update" and does not contact the repository server at all.		: This looks through your working copies for modifications, then checks if that file differs from the local copy. If it differs, the working copy file is copied over the local copy one. Note that this is very different from "svn update" and does not contact the repository server at all.

			=== ASH Commands ===
			There are a few additional functions that ASH possesses to check up on an SVN repo.
			* {{Flink\|boolean\|svn_exists\|string\|desc=Returns true if a valid working copy named projectname exists in the /svn folder.}}
			* {{Flink\|boolean\|svn_at_head\|string\|desc=Returns true if projectname exists, is a valid working copy, and is currently at the same revision number as the repository.}}
			* {{Flink\|record\|svn_info\|string\|desc=Returns a record containing additional information about the given projectname: svnurl, last author, last revision, last change date.}}

	== Revision Merging ==		== Revision Merging ==

Bale: /* Information for Scripters */

2014-11-11T11:15:06Z

Information for Scripters

← Older revision		Revision as of 11:15, 11 November 2014
Line 41:		Line 41:
	It is more than just a place to save files though. There is something called a Working Copy, which is a local version of a remote repository, plus any local changes you may have made. The process of creating this Working Copy is referred to as "checking out" the repo, or "checkout." You have probably also heard the term "commit" which is simply taking some/all local changes in a working copy and syncing them with the repo. Then other users sync their working copies with the repo, and voila!		It is more than just a place to save files though. There is something called a Working Copy, which is a local version of a remote repository, plus any local changes you may have made. The process of creating this Working Copy is referred to as "checking out" the repo, or "checkout." You have probably also heard the term "commit" which is simply taking some/all local changes in a working copy and syncing them with the repo. Then other users sync their working copies with the repo, and voila!

	=== How ~~it Works~~ ===		=== How to Set Up a Repo ===
	A working copy contains a hidden folder, .svn, that contains all of the metadata needed to know how your local version differs from the repository's version. This is created for you when you checkout the project. You don't really need to know any of these details, really, for the most part using svn does not require knowing how it works under the hood. What you may be interested in is how to create your own repo.		A working copy contains a hidden folder, .svn, that contains all of the metadata needed to know how your local version differs from the repository's version. This is created for you when you checkout the project. You don't really need to know any of these details, really, for the most part using svn does not require knowing how it works under the hood. What you may be interested in is how to create your own repo.

Line 48:		Line 48:
	First, get a [https://sourceforge.net/ sourceforge] account. Make a new project there. Download [http://tortoisesvn.net/downloads.html TortoiseSVN] and install it. Make a new folder somewhere on your computer. Right-click, and choose SVN Checkout... from the context menu. You will want to give it the address that you see on your new sourceforge project code page - for now just grab the http:// address, it's easier. Ignore the commands in front of the address and after it, those are for command-line svn tools.		First, get a [https://sourceforge.net/ sourceforge] account. Make a new project there. Download [http://tortoisesvn.net/downloads.html TortoiseSVN] and install it. Make a new folder somewhere on your computer. Right-click, and choose SVN Checkout... from the context menu. You will want to give it the address that you see on your new sourceforge project code page - for now just grab the http:// address, it's easier. Ignore the commands in front of the address and after it, those are for command-line svn tools.

	The rest of the default options are okay. Click OK and you should get a new working copy of your repo! Cool. Open it up and let's add some stuff. Add a new directory ~~(call it whatever), within that directory add a folder~~ called scripts/, and within scripts/ put a new text file. Now navigate back up to the root of your working copy, right click on the folder, and choose SVN commit... Tick all the files/folders (tick the "show unversioned files" box if it's not ticked), give it a quick commit comment up top. You should have to enter your sourceforge user information, save it if you want. If you've done everything correctly, your new project should have been committed.		The rest of the default options are okay. Click OK and you should get a new working copy of your repo! Cool. Open it up and let's add some stuff. Add a new directory called scripts/, and within scripts/ put a new text file. Now navigate back up to the root of your working copy, right click on the folder, and choose SVN commit... Tick all the files/folders (tick the "show unversioned files" box if it's not ticked), give it a quick commit comment up top. You should have to enter your sourceforge user information, save it if you want. If you've done everything correctly, your new project should have been committed.

	Optional: to really play around with this, checkout a second working copy somewhere in another folder on your computer. Try committing changes from one working copy to the repo, then doing right-click SVN Update on the other working copy. Notice how TortoiseSVN helpfully changes the little file/folder icons for you when you make modifications to things. Hopefully you're starting to see how this whole thing works.		Optional: to really play around with this, checkout a second working copy somewhere in another folder on your computer. Try committing changes from one working copy to the repo, then doing right-click SVN Update on the other working copy. Notice how TortoiseSVN helpfully changes the little file/folder icons for you when you make modifications to things. Hopefully you're starting to see how this whole thing works.

Bale: /* Non-Technical FAQ */

2014-11-11T11:08:53Z

Non-Technical FAQ

← Older revision		Revision as of 11:08, 11 November 2014
Line 12:		Line 12:
	'''Q. What do I have to know about SVN to use this feature?'''<br />		'''Q. What do I have to know about SVN to use this feature?'''<br />
	A. Absolutely nothing! There's a Script Manger under the Scripts menu. You can select scripts you want to install, right-click and select "install script." Then the magic happens. It's really simple.		A. Absolutely nothing! There's a Script Manger under the Scripts menu. You can select scripts you want to install, right-click and select "install script." Then the magic happens. It's really simple.
	:[[File:~~Script_Manager~~.png]]		:[[File:Script_Manager_Abridged.png]]

	'''Q. At the top of the page you said "automatically update scripts." None of my scripts have updated themselves so how does that work?'''<br />		'''Q. At the top of the page you said "automatically update scripts." None of my scripts have updated themselves so how does that work?'''<br />