From 774fa4fc7d3795471b48a76e5eda2f14b99afa97 Mon Sep 17 00:00:00 2001 From: Niclas Zeising Date: Wed, 10 Jun 2020 18:55:57 +0000 Subject: [PATCH] porters handbook: De-empasize the use of shar De-empasize the use of shar archives when submitting new ports. When we were still using gnats and CVS, shar was the best way of submitting new ports to the PR database, for inclusion in the ports tree. These days, it is usually easier to use a patch from svn, or even git. Move the shar example further to the bottom of the page in the section about submitting ports to the FreeBSD project. Dicussed with: many Reviewed by: allanjude, bapt, bcr, emaste, mat Differential Revision: https://reviews.freebsd.org/D25148 --- .../quick-porting/chapter.xml | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml index 2df723f156..849148758b 100644 --- a/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml +++ b/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml @@ -358,7 +358,7 @@ lib/X11/oneko/mouse.xpm now. - Next, either create a &man.patch.1;, or a &man.shar.1; file. + Next, create a &man.patch.1;, file. Assuming the port is called oneko and is in the games category. @@ -384,20 +384,7 @@ lib/X11/oneko/mouse.xpm - - Creating a <filename>.shar</filename> for a New - Port - - cd to the directory above where the - port directory is located, and use shar to - create the archive: - - &prompt.user; cd .. -&prompt.user; shar `find oneko` > oneko.shar - - - Submit one of oneko.shar or - oneko.diff with the Submit oneko.diff with the bug submission form. Use product Ports & Packages, component Individual Port(s), @@ -405,7 +392,6 @@ lib/X11/oneko/mouse.xpm Add a short description of the program to the Description field of the PR (perhaps a short version of COMMENT), and remember to add - oneko.shar or oneko.diff as an attachment. @@ -435,5 +421,21 @@ lib/X11/oneko/mouse.xpm added to the list of Additional &os; Contributors and other files. + + It is also possible to submit ports using a &man.shar.1; file. Using + the previous example with the oneko port above. + + + Creating a <filename>.shar</filename> for a New Port + + go to the directory above where the + port directory is located, and use tar to + create the shar archive: + + &prompt.user; cd .. + &prompt.user; tar cf oneko.shar --format shar oneko + + oneko.shar can then be submitted in the same way + as oneko.diff above.