[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-frameworks-devel
Subject: Re: Review Request 127747: Create a new script that generate the documentation for all projects foll
From: Olivier Churlaud <olivier () churlaud ! com>
Date: 2016-05-20 16:50:48
Message-ID: 20160520165048.15344.51122 () mimi ! kde ! org
[Download RAW message or body]
--===============7883836092309882337==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
> On May 20, 2016, 3:50 a.m., Michael Pyne wrote:
> > I've looked at the code itself and it seems reasonable, so from that perspective \
> > and given the length of time there's been no -1's, I think it's safe to commit.
> > However you mentioned in the description that this isn't safe to commit to \
> > master. I have no clue how we generate apidox for KF5 and Plasma 5 so I'm not \
> > sure what you mean when you say we'd affect the currents script. What is your \
> > plan for integrating this without breaking the scripts? Is there work needed by \
> > others (sysadmin, EBN, etc.) to make apidox generation work with your patch \
> > committed? What's the action KDE developers must take after this, if any?
>
> Olivier Churlaud wrote:
> Thank you for the review Michel. The only need will be to update the metainfo.yml. \
> I can do that for the frameworks if needed after commiting. Or I can even do this \
> before so that it doesn't break.
> Commit plan:
> 1) update frameworks metainfo (they are back-compatibles but the *new* script will \
> break with the old metainfo. 2) commit in master
> 3) See if everything works as expected else correct.
> 4) Clean up the code and teach it new tricks ; Add other projects that the \
> frameworks.
> Olivier Churlaud wrote:
> Oh and maybe the current folder containing the html pages should be removed as \
> well.
I forgot something. The name of the script will change. So I have to either see with \
a sysadmin to change the cronjob or overright the previous one.
- Olivier
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/127747/#review95632
-----------------------------------------------------------
On April 25, 2016, 11:49 p.m., Olivier Churlaud wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/127747/
> -----------------------------------------------------------
>
> (Updated April 25, 2016, 11:49 p.m.)
>
>
> Review request for KDE Frameworks, Albert Astals Cid, Alex Merry, Aurélien \
> Gâteau, and Allen Winter.
>
> Repository: kapidox
>
>
> Description
> -------
>
> Keep in mind that it should not plainly replace kgenframeworks but be used by all \
> KDE projects. So in this proposition, the Frameworks are just one project in \
> others.
> The code can be tested directly by checking the branch \
> `olivier/generate_all_repos`.
> This MUST NOT be merged in master, because it will break the currents scripts (see \
> commit 3643dded7cf14a5634879e8e6e34be8840143d7e).
>
> Diffs
> -----
>
> konqi_frameworks.png PRE-CREATION
> metainfo.yaml 4ff17c8
> metainfo_syntax.md PRE-CREATION
> src/kapidox/data/htmlresource/default_product.png PRE-CREATION
> src/kapidox/data/htmlresource/kde.css b864ef5
> src/kapidox/data/templates/doxygen2.html PRE-CREATION
> src/kapidox/data/templates/frontpage.html PRE-CREATION
> src/kapidox/data/templates/libinfo.html PRE-CREATION
> src/kapidox/data/templates/maintainers.html PRE-CREATION
> src/kapidox/data/templates/subgroup.html PRE-CREATION
> src/kapidox/generator.py 5b8ae40
> src/newkapidox.py PRE-CREATION
> src/notes PRE-CREATION
>
> Diff: https://git.reviewboard.kde.org/r/127747/diff/
>
>
> Testing
> -------
>
> Tested on various scenario cases.
>
>
> File Attachments
> ----------------
>
> This is an example of what I generated. (Threadweaver is duplicated and modified to \
> test different scenarios) \
> https://git.reviewboard.kde.org/media/uploaded/files/2016/04/25/2e4549e4-7c17-416c-9a72-b82d3bba18b3__doc.tar.gz
>
>
> Thanks,
>
> Olivier Churlaud
>
>
--===============7883836092309882337==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 8bit
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;"> \
<tr> <td>
This is an automatically generated e-mail. To reply, visit:
<a href="https://git.reviewboard.kde.org/r/127747/">https://git.reviewboard.kde.org/r/127747/</a>
</td>
</tr>
</table>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <p style="margin-top: 0;">On May 20th, 2016, 3:50 a.m. CEST, <b>Michael \
Pyne</b> wrote:</p> <blockquote style="margin-left: 1em; border-left: 2px solid \
#d0d0d0; padding-left: 10px;"> <pre style="white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">I've looked at the code itself and it seems reasonable, so from that \
perspective and given the length of time there's been no -1's, I think \
it's safe to commit.
However you mentioned in the description that this isn't safe to commit to \
master. I have no clue how we generate apidox for KF5 and Plasma 5 so I'm not \
sure what you mean when you say we'd affect the currents script. What is your \
plan for integrating this without breaking the scripts? Is there work needed by \
others (sysadmin, EBN, etc.) to make apidox generation work with your patch \
committed? What's the action KDE developers must take after this, if any?</pre> \
</blockquote>
<p>On May 20th, 2016, 7:44 a.m. CEST, <b>Olivier Churlaud</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Thank \
you for the review Michel. The only need will be to update the metainfo.yml. I can do \
that for the frameworks if needed after commiting. Or I can even do this before so \
that it doesn't break.</p> <p style="padding: 0;text-rendering: inherit;margin: \
0;line-height: inherit;white-space: inherit;">Commit plan: 1) update frameworks \
metainfo (they are back-compatibles but the <em style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: normal;">new</em> script will \
break with the old metainfo. 2) commit in master
3) See if everything works as expected else correct.
4) Clean up the code and teach it new tricks ; Add other projects that the \
frameworks.</p></pre> </blockquote>
<p>On May 20th, 2016, 8 a.m. CEST, <b>Olivier Churlaud</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Oh \
and maybe the current folder containing the html pages should be removed as \
well.</p></pre> </blockquote>
</blockquote>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">I \
forgot something. The name of the script will change. So I have to either see with a \
sysadmin to change the cronjob or overright the previous one.</p></pre> <br />
<p>- Olivier</p>
<br />
<p>On April 25th, 2016, 11:49 p.m. CEST, Olivier Churlaud wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;"> <tr>
<td>
<div>Review request for KDE Frameworks, Albert Astals Cid, Alex Merry, Aurélien \
Gâteau, and Allen Winter.</div> <div>By Olivier Churlaud.</div>
<p style="color: grey;"><i>Updated April 25, 2016, 11:49 p.m.</i></p>
<div style="margin-top: 1.5em;">
<b style="color: #575012; font-size: 10pt;">Repository: </b>
kapidox
</div>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">Keep in mind that it should not plainly replace \
kgenframeworks but be used by all KDE projects. So in this proposition, the \
Frameworks are just one project in others.</p> <p style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: inherit;">The code can be tested \
directly by checking the branch <code style="text-rendering: inherit;color: \
#4444cc;padding: 0;white-space: normal;margin: 0;line-height: \
inherit;">olivier/generate_all_repos</code>.</p> <p style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: inherit;">This MUST NOT be merged \
in master, because it will break the currents scripts (see commit \
3643dded7cf14a5634879e8e6e34be8840143d7e).</p></pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">Tested on various scenario cases.</p></pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>konqi_frameworks.png <span style="color: grey">(PRE-CREATION)</span></li>
<li>metainfo.yaml <span style="color: grey">(4ff17c8)</span></li>
<li>metainfo_syntax.md <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/htmlresource/default_product.png <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/htmlresource/kde.css <span style="color: \
grey">(b864ef5)</span></li>
<li>src/kapidox/data/templates/doxygen2.html <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/templates/frontpage.html <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/templates/libinfo.html <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/templates/maintainers.html <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/templates/subgroup.html <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/generator.py <span style="color: grey">(5b8ae40)</span></li>
<li>src/newkapidox.py <span style="color: grey">(PRE-CREATION)</span></li>
<li>src/notes <span style="color: grey">(PRE-CREATION)</span></li>
</ul>
<p><a href="https://git.reviewboard.kde.org/r/127747/diff/" style="margin-left: \
3em;">View Diff</a></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">File Attachments \
</h1>
<li><a href="https://git.reviewboard.kde.org/media/uploaded/files/2016/04/25/2e4549e4-7c17-416c-9a72-b82d3bba18b3__doc.tar.gz">This \
is an example of what I generated. (Threadweaver is duplicated and modified to test \
different scenarios)</a></li>
</ul>
</td>
</tr>
</table>
</div>
</body>
</html>
--===============7883836092309882337==--
[Attachment #3 (text/plain)]
_______________________________________________
Kde-frameworks-devel mailing list
Kde-frameworks-devel@kde.org
https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic