Bug 173971

Summary: fdp-primer quick start section makes reference to 'make lint'
Product: Documentation Reporter: Derek Wood <ddwood>
Component: Books & ArticlesAssignee: Gabor Kovesdan <gabor>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Derek Wood 2012-11-28 15:50:00 UTC
As per eadler@, 'make lint' in the FreeBSD document tree is broken, and the reference to it in the fdp-primer book ( http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview-quick-start.html ) is erroneous.
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2012-11-28 16:59:13 UTC
[ccing hrs as he is the one whom added the target in the first place]

On 28 November 2012 10:40, Derek Wood <ddwood@outlook.com> wrote:
> As per eadler@, 'make lint' in the FreeBSD document tree is broken, and the reference to it in the fdp-primer book ( http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview-quick-start.html ) is erroneous.
>>How-To-Repeat:

My understanding is that the "make lint" target is currently broken
and non-useful.  If I am wrong and this target is intended to work
please let me know.

This patch removes the target and text explaining it.

commit 2e984ecbace3df739ecf147c76fcd6d2645c33cb
Author: Eitan Adler <lists@eitanadler.com>
Date:   Wed Nov 28 11:57:26 2012 -0500

    Remove 'lint' make target which is currently broken and non-useful.

    PR:		docs/173971
    Submitted by:	Derek Wood <ddwood@outlook.com> (pr)

diff --git a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
index 2930c47..6fecb16 100644
--- a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
@@ -257,13 +257,6 @@
       </step>

       <step>
-	<para>Test the markup using the <maketarget>lint</maketarget>
-	  target.  This will quickly find any errors in the document
-	  without actually performing the time-consuming
-	  transformation.</para>
-
-	<screen>&prompt.user; <userinput>make lint</userinput></screen>
-
 	<para>When you are ready to actually build the document, you
 	  may specify a single format or a list of formats in the
 	  <varname>FORMATS</varname> variable.  Currently,
diff --git a/share/mk/doc.xml.mk b/share/mk/doc.xml.mk
index a749ae9..a4b1229 100644
--- a/share/mk/doc.xml.mk
+++ b/share/mk/doc.xml.mk
@@ -373,13 +373,5 @@ ${TARGET.${_ID}}: ${XML.${_ID}} ${DEPENDS.${_ID}}
 	${XSLTPROC} ${XSLTPROCOPTS.${_ID}} \
 		-o ${.TARGET} ${PARAMS.${_ID}} \
 		${XSLT.${_ID}} ${XML.${_ID}}
-
-VALIDATE_DOCS+=	VALIDATE.${_ID}
-VALIDATE.${_ID}:
-	@${ECHO} "==>[xmllint] ${XML.${_ID}}"
-	-@${XMLLINT} ${XMLLINTOPTS} ${XML.${_ID}} 2>&1  \
-		| ${SED} -e 's/^/ | /'
 .  endfor
 .endfor
-
-lint: ${VALIDATE_DOCS}



-- 
Eitan Adler
Comment 2 Gabor Kovesdan freebsd_committer freebsd_triage 2012-11-28 22:22:25 UTC
The make lint target is going to work soon. Please do not remove the
references from fdp-primer

Gabor
Comment 3 Eitan Adler freebsd_committer freebsd_triage 2012-11-30 02:54:11 UTC
---------- Forwarded message ----------
From: Eitan Adler <lists@eitanadler.com>
Date: 28 November 2012 21:21
Subject: Re: docs/173971: fdp-primer quick start section makes
reference to &#39;make lint&#39;
To: Gabor Kovesdan <gabor@freebsd.org>
Cc: freebsd-doc@freebsd.org


On 28 November 2012 17:40, Gabor Kovesdan <gabor@freebsd.org> wrote:
> The following reply was made to PR docs/173971; it has been noted by GNATS.
>
> From: Gabor Kovesdan <gabor@FreeBSD.org>
> To: bug-followup@FreeBSD.org, ddwood@outlook.com
> Cc:
> Subject: Re: docs/173971: fdp-primer quick start section makes reference to
>  &#39;make lint&#39;
> Date: Wed, 28 Nov 2012 23:22:25 +0100
>
>  The make lint target is going to work soon. Please do not remove the
>  references from fdp-primer

okay. I'll leave this PR open as "make lint doesn't work."  Please
close it when the fix is committed.

--
Eitan Adler


-- 
Eitan Adler
Comment 4 Eitan Adler freebsd_committer freebsd_triage 2012-12-11 18:22:15 UTC
Responsible Changed
From-To: freebsd-doc->gabor

over to owner
Comment 5 Gabor Kovesdan freebsd_committer freebsd_triage 2013-05-17 19:58:59 UTC
State Changed
From-To: open->closed

Running make lint works again. Thanks for your report!