Changes between Version 3 and Version 4 of SummerOfCode2017

Timestamp:

Oct 20, 2019, 10:24:03 AM (5 years ago)

Author:

umeshksingla (Umesh Singla)

Comment:

add details for port migrate

SummerOfCode2017

@@ -5 +5 @@
 
 || '''Project''' || '''Student''' || '''Mentor''' ||
-|| [wiki:SummerOfCode2017#migrate Adding migration action to port command] || Umesh Kumar Singla || [wiki:pixilla Bradley Giesbrecht] ||
+|| [wiki:SummerOfCode2017#migrate Adding migration action to port command] || [wiki:umeshksingla Umesh Singla]  || [wiki:pixilla Bradley Giesbrecht] ||
 || [wiki:SummerOfCode2017#bot-ci Bot and CI for macports-ports] || [wiki:l2dy Zero King] || [wiki:mojca Mojca Miklavec], [wiki:cal Clemens Lang] ||
 
 == Adding migration action to port command == #migrate
 
-A MacPorts installation is designed to work with a particular OS and a particular hardware architecture. After major system changes like an OS upgrade or hardware change, currently, MacPorts users have to follow a set of manual migration instructions to ensure a smooth transition. The purpose of this project is to automate the processes described in the migration documentation, so that following the migration steps is no longer challenging for casual users or for anyone. The migration tool would install a new port command and using PortIndex, it would uninstall and reinstall the requested ports with variants.
+A MacPorts installation is designed to work with a particular OS and a particular hardware architecture. After major system changes like an OS upgrade or hardware change, currently, MacPorts users have to follow a set of manual migration instructions to ensure a smooth transition. The purpose of this project is to automate the processes described in the migration documentation so that following the migration steps is no longer challenging for casual users or for anyone. The migration tool would install a new port command and using PortIndex, it would uninstall and reinstall the requested ports with variants.
 
 [https://summerofcode.withgoogle.com/dashboard/project/5130769411342336/details/ Project on Google's SoC Dashboard (Login required)]
 
+==== How to use: ====
+
+* **NOTE 1: Make sure to take a backup of your requested ports and all ports first in a file.**
+* NOTE 2: It'd be better to keep the interactive mode on, so you know what's going on from time to time. [[BR]] There is a problem with restoring build dependencies at the moment, so it sometimes asks to continue.
+
+Run `sudo port migrate` after upgrading your system. It will create a snapshot of your ports first, and restore the active ports then. If there is a need to update macports, it will fail and notify. Try to follow the notes output at the end of its command.
+
+You can also use:
+`sudo port snapshot --note "some optional note"`  to create a snapshot yourself and later restore it using `sudo port restore --snapshot-id X`.
+
+At any point, if the restore fails and you need to do some manual changes in the registry, you can simply start the restore again afterward, using the same command as above.
+
 == Bot and CI for macports-ports == #bot-ci
 
-Right now PRs have to be manually tested by commiters and some commiters aren't aware of new PRs at all. Also certain information like whether the PR is submitted by the port maintainer have to be checked manually.
+Right now PRs have to be manually tested by commiters and some commiters aren't aware of new PRs at all. Also, certain information like whether the PR is submitted by the port maintainer have to be checked manually.
 
 [wiki:l2dy] plans to implement a bot in Go dealing with PRs for macports-ports and utilize Travis CI to test commits and PRs.