You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Julian Foad <ju...@btopenworld.com> on 2015/03/03 12:57:26 UTC
Re: [PATCH] doxygen docs += svn logo
Daniel Shahaf wrote:
> Patch to add the project logo to the top-left of generated doxygen
> pages. Not sure what are the consequences of using a logo larger than
> 200x55 pixels, so won't commit it for now.
+1. Go ahead and commit it. I tried it locally and it looks nice in my version of Firefox and a quick look at the HTML doesn't indicate there will be any problem, and it's hardly a disaster if we have to change or revert it later.
> If adding a file external is a problem, it would be straightforward to
> avoid that by using 'svn cat ^/subversion/site/...' in the 'doc'
> Makefile target; the trade-off is requiring an Internet connection and
> an svn binary to be available.
I can't think of a problem with using the external. If it doesn't work in production, we can change it.
>
> (To test it,
... put the patch in a file; patch up the whitespace to use a tab after the filenames and a space at the beginning of context lines; apply with 'svn patch'; run 'svn update' to fetch the external; and then ...
> run 'make doc', the output will be in ./doc/doxygen/.)
- Julian
> [[[
> doxygen: include the svn logo at the top of generated documentation pages.
>
> * doc/svn-square.jpg:
> New file. Alias to site/publish/images/svn-square.jpg, via svn:externals.
>
> * doc/doxygen.conf
> (PROJECT_LOGO): Set to the square logo (was unset).
> ]]]
>
> [[[
> Index: doc/doxygen.conf
> ===================================================================
> --- doc/doxygen.conf (revision 1662688)
> +++ doc/doxygen.conf (working copy)
> @@ -33,6 +33,13 @@ PROJECT_NAME = Subversion
>
> PROJECT_NUMBER =
>
> +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
> +# in the documentation. The maximum height of the logo should not exceed 55
> +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
> +# the logo to the output directory.
> +
> +PROJECT_LOGO = doc/svn-square.jpg
> +
> # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
> # base path where the generated documentation will be put.
> # If a relative path is entered, it will be relative to the location
> Index: doc
> ===================================================================
> --- doc (revision 1661135)
> +++ doc (working copy)
>
> Property changes on: doc
> ___________________________________________________________________
> Added: svn:externals
> ## -0,0 +1 ##
> +^/subversion/site/publish/images/svn-square.jpg svn-square.jpg
> ]]]
>
Re: [PATCH] doxygen docs += svn logo
Posted by Julian Foad <ju...@btopenworld.com>.
Daniel Shahaf wrote:
> Julian Foad wrote on Tue, Mar 03, 2015 at 11:57:26 +0000:
>> +1. [...]
>
> Fair enough. Committed as r1663837.
Thanks! It looks fine on the 1.9-dev and 1.10-dev docs at
http://subversion.apache.org/docs/
[...]
>> ... put the patch in a file; patch up the whitespace to use a tab
>> after the filenames and a space at the beginning of context lines;
>
> The tabs and whitespace are correct in the copy I received from the
> list. Perhaps your MUA ate the whitespace?
Oh dear, yes I can easily accept it's my MUA's fault. I've been using 'BT Yahoo' web mail, branded by British Telecom, provided by Yahoo, as I understand it -- and it's got lots of problems with white space and similar things. Apologies for the implied criticism -- that was what I had to do, but I didn't stop to think about where the problem had arisen.
- Julian
Re: [PATCH] doxygen docs += svn logo
Posted by Daniel Shahaf <d....@daniel.shahaf.name>.
Julian Foad wrote on Tue, Mar 03, 2015 at 11:57:26 +0000:
> Daniel Shahaf wrote:
> > Patch to add the project logo to the top-left of generated doxygen
> > pages. Not sure what are the consequences of using a logo larger than
> > 200x55 pixels, so won't commit it for now.
>
> +1. Go ahead and commit it. I tried it locally and it looks nice in my
> version of Firefox and a quick look at the HTML doesn't indicate there
> will be any problem, and it's hardly a disaster if we have to change
> or revert it later.
>
Fair enough. Committed as r1663837.
> > If adding a file external is a problem, it would be straightforward to
> > avoid that by using 'svn cat ^/subversion/site/...' in the 'doc'
> > Makefile target; the trade-off is requiring an Internet connection and
> > an svn binary to be available.
>
> I can't think of a problem with using the external. If it doesn't work in production, we can change it.
>
> >
> > (To test it,
>
> ... put the patch in a file; patch up the whitespace to use a tab
> after the filenames and a space at the beginning of context lines;
The tabs and whitespace are correct in the copy I received from the
list. Perhaps your MUA ate the whitespace?
Thanks,
Daniel