135
edits
Changes
Jump to navigation
Jump to search
Line 4:
Line 4: + − + Line 15:
Line 16: + + + + + + + + + + − + − +
no edit summary
* Large graphics files, like Photoshop and InDesign
* Large graphics files, like Photoshop and InDesign
* A few CAD and simulation projects
* A few CAD and simulation projects
* Templates for and config files for [[:Category:Altium|Altium Designer]]
SSI used to store many more things on SVN, namely PCB designs, Solidworks CAD, and Altium Libraries. Over time, these things migrated to their own platforms: GrabCAD, Altium365, and Github.
SSI used to store many more things on SVN, namely PCB designs, Solidworks CAD, and Altium Libraries. Over time, these things migrated to their own platforms: Github, GrabCAD, and Altium365, repectively.
===Background===
===Background===
Changes other people make to files stored in the SVN must be downloaded manually, through the SVN '''update''' command. Updating replaces any files in your SVN folder that have been changed since the last time you ran SVN update with their most recently committed versions.
Changes other people make to files stored in the SVN must be downloaded manually, through the SVN '''update''' command. Updating replaces any files in your SVN folder that have been changed since the last time you ran SVN update with their most recently committed versions.
===Getting Access to the SVN===
Getting access is now easier than ever. Head on over to [https://ssi-svn.stanford.edu/ ssi-svn.stanford.edu]. You'll need to login with your SUID. The page will try to find any saved passwords attached to your username. If none are found, just click the link to generate a new password. From then on, the generated password will be displayed on that page. The displayed username and password is what you'll use to connect to SVN. You can write it down somewhere, or just come back to that page every time you need it.
===Exploring an SVN Repo===
The [https://ssi-svn.stanford.edu/ ssi-svn.stanford.edu] page should now show a list of all the SSI SVN Repositories. Try clicking on the first, "altium-core". It will prompt for a username and password, see above. The page should now show the files in the root of the repository. Click on "iwuzhere.txt." It's a list of everyone who has followed this guide! Lets get you added to the list.
=== Installing an SVN client ===
You will need SVN software to use the SSI Altium repository. The recommended choice is to install [http://tortoisesvn.net/ Tortoise SVN] (Windows-only). There are solutions for Mac and Linux users as well, though none quite as streamlined as TortoiseSVN; many Linux and Max users use the command line (Terminal) to handle SVN.
TortoiseSVN will run persistently on your computer and allow you to work with files synchronized with the SVN. As shown at right, TortoiseSVN will appear as a menu available when right clicking on files or folders. We will introduce the most useful of these commands in this article; several more are discussed [[Using TortoiseSVN|here]] (recommended reading ''after'' completing this guide).
===Downloading SSI Altium SVN===
[[File:SVNCheckout.png|thumb|200px|right|Make sure you're right clicking on the folder you just created.]][[File:SVNCheckout2.png|thumb|200px|right|Your checkout window should look very similar to this.]]Find a convenient location on your computer (i.e. your desktop) to create a folder that will host all of the shared SSI Altium files. Create a new folder there (my folder is called "SVN-SSI-Altium," though "altium-core" is what the folder is called on the server). Right click on the folder, and select "SVN Checkout" (see right). A window should pop up (see right) showing a URL to download files from and a location on your computer where the files will be downloaded. Verify that the target on your computer is where you intend and set the URL of the repository to {{altium-repo}}, and click OK. You will then likely be prompted for your SVN login - this will be your '''username''' and password Slacked to you after you requested them. You do not need credentials to download the libraries on campus, but you do need credentials to push changes to the libraries (regardless of where you are). Enter credentials if you have them, click OK, and your computer should begin to download the Altium libraries. These should take less than a minute to download on campus.
===Your First Commit===
===Your First Commit===
[[File:MakingACommit.png|thumb|200px|right|You will likely only have iwuzhere.txt in your list of files to commit, but if you have others, leave them unchecked.]]
[[File:MakingACommit.png|thumb|200px|right|You will likely only have iwuzhere.txt in your list of files to commit, but if you have others, leave them unchecked.]]
In your SSI Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Update" and click it. This will quickly bring all of your files up to date. Next, in your Altium SVN folder, find "iwuzhere.txt." This file is tracked by the SVN repository, and should have a small green check mark on it. Right click on the file, mouse down to "TortoiseSVN," and then click "Get lock..." Click OK on any windows that appear. A small lock icon should appear on the file - you now have the lock on this file.
In your SSI Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Update" and click it. This will quickly bring all of your files up to date. Next, in your Altium SVN folder, find "iwuzhere.txt." This file is tracked by the SVN repository, and should have a small green check mark on it. Right click on the file, mouse down to "TortoiseSVN," and then click "Get lock..." Click OK on any windows that appear. A small lock icon should appear on the file - you now have the lock on this file.
If the file was already locked by someone else, you will not be able to lock it, and should message the {{slack-channel|altium}} to ask to lock it. If you do not receive a response within 10 minutes, lock the file as described above, and check "Steal the locks" to take the lock from whomever had it previously. Slack is how locking conflicts like this (which are rare) are resolved, and 10 minutes is a short period of time to wait for a response, but this file is simple and very little work is lost from stealing the lock on it. If someone else commits a new version of the file, run another SVN update, and then you should be able to lock it.
If the file was already locked by someone else, you will not be able to lock it, and should message in Slack to ask to lock it. If you do not receive a response within 10 minutes, lock the file as described above, and check "Steal the locks" to take the lock from whomever had it previously. Slack is how locking conflicts like this (which are rare) are resolved, and 10 minutes is a short period of time to wait for a response, but this file is simple and very little work is lost from stealing the lock on it. If someone else commits a new version of the file, run another SVN update, and then you should be able to lock it.
Open the file, and add your name and the current date, matching the format of the names already there. ''You're now a part of SSI's corps of electrical engineers!''
Open the file, and add your name and the current date, matching the format of the names already there. ''You're now a part of SSI's corps of SVN users!''
To finish, go back to your Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Commit..." and click it. A dialog box will come up (see right), at the bottom of which should be a list of files. This shows files you have changed since the last time you ran SVN update, and ''should'' just have iwuzhere.txt listed. Make sure you have it checked. In the text box at the top of the window, you will need to write a '''commit message''', a brief description of what changes you're committing. This message will appear in Slack and must be at least 20 characters (but shouldn't be longer than a single sentence). Once you've written it, click okay, and wait for a message to appear in Slack.
To finish, go back to your Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Commit..." and click it. A dialog box will come up (see right), at the bottom of which should be a list of files. This shows files you have changed since the last time you ran SVN update, and ''should'' just have iwuzhere.txt listed. Make sure you have it checked. In the text box at the top of the window, you will need to write a '''commit message''', a brief description of what changes you're committing. This message will appear in Slack and must be at least 20 characters (but shouldn't be longer than a single sentence). Once you've written it, click okay, and wait for a message to appear in Slack.