Re: [PATCH] Fixing namespace edit (#319116)

"Mario Sopena Novales" <[email protected]> Fri, 22 Feb 2008 19:49:41 +0100
Newsgroups gmane.comp.gnome.mono.documentation
Message-ID <[email protected]>
------=_Part_741_30953010.1203706182042
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

Hi,

   I fixed all the indentation mess. More comments below:

On 22/02/2008, Jonathan Pryor <[email protected]> wrote:
> On Fri, 2008-02-22 at 18:08 +0100, Mario Sopena Novales wrote:
>  > Index: provider.cs
>  > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>  > --- provider.cs (revisi=F3n: 96411)
>  > +++ provider.cs (copia de trabajo)
>  > @@ -609,9 +609,13 @@
>  >                 }
>  >         }
>  >
>  > -       public void PackXml (string fname, XmlDocument doc)
>  > +       public void PackXml (string fname, XmlDocument doc, string rea=
l_path)
>  >         {
>  > -               zip_output.PutNextEntry (new ZipEntry (fname));
>  > +        ZipEntry entry =3D new ZipEntry (fname);
>  > +        if (real_path !=3D null)
>  > +            entry.ExtraData =3D ConvertToArray(real_path);
>  > +
>  > +               zip_output.PutNextEntry (entry);
>
>  Please fix your indenting.
>
>  > Index: mono-ecma-css.xsl
>  > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>  > --- mono-ecma-css.xsl   (revisi=F3n: 96411)
>  > +++ mono-ecma-css.xsl   (copia de trabajo)
>  > @@ -684,7 +684,7 @@
>  >                                 <xsl:apply-templates select=3D"summary=
" mode=3D"notoppara"/>
>  >                                 <xsl:if test=3D"monodoc:MonoEditing()"=
>
>  >                                         <xsl:value-of select=3D"' '" /=
>
>  > -                                       <a href=3D"{monodoc:EditUrlNam=
espace ($namespace, 'summary')}">[Edit]</a>
>  > +                                       [<a href=3D"{monodoc:EditUrlNa=
mespace (., $namespace, 'summary')}">Edit</a>]
>
>  Any particular reason you don't want the '[' and ']' as part of the link
>  text?  I'd prefer to keep them as part of the link.

Because the other Edit links are like this, so I though it would be
better to keep all unified.


>
>  > Index: ecma-provider.cs
>  > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>  > --- ecma-provider.cs    (revisi=F3n: 96411)
>  > +++ ecma-provider.cs    (copia de trabajo)
>  > @@ -184,6 +184,7 @@
>  >                                         if (File.Exists (ns_summary_fi=
le)) {
>  >                                                 XmlDocument nsSummaryF=
ile =3D new XmlDocument ();
>  >                                                 nsSummaryFile.Load (ns=
_summary_file);
>  > +                        namespace_realpath [tn] =3D ns_summary_file;
>
>  Fix indentation.
>
>  > @@ -869,16 +871,16 @@
>  >
>  >                         match_node =3D ns_node;
>  >                         string ns_name =3D nsurl.Substring (2);
>  > -
>  > -                       XmlReader summary =3D GetNamespaceDocument (ns=
_name);
>  > -                       if (summary =3D=3D null)
>  > +
>  > +            XmlDocument doc =3D GetHelpXmlWithChanges("xml.summary." =
+ ns_name);
>  > +            if (doc =3D=3D null)
>  >                                 return null;
>
>  Shouldn't this fall-back to using GetNamspaceDocument() if
>  GetHelpXmlWithChanges() fails?

Well, the reason is that GetNamespaceDocument calls GetHelpXml() which
is a function copy&pasted to GetHelpXmlWithChanges except for the
later calling one extra method to detect whether there are changes and
applying them. In fact, I think we should remove
GetNamespaceDocument... well, I think the monodoc "library" need a
heavy refactoring because it is a little mess, I just don't find
enough free time to do it, ;-P


>
>  > @@ -1181,10 +1183,12 @@
>  >                         return "";
>  >                 }
>  >
>  > -               public string EditUrlNamespace (string ns, string sect=
ion)
>  > +               public string EditUrlNamespace (XPathNodeIterator itr,=
 string ns, string section)
>  >                 {
>  >                         if (hs is EcmaUncompiledHelpSource)
>  >                                 return "edit:file:" + Path.Combine(((E=
cmaUncompiledHelpSource)hs).BasePath, ns + ".xml") + "@/Namespace/Docs/" + =
section;
>  > +            else if (itr.MoveNext ())
>  > +                return EditingUtils.FormatEditUri(itr.Current.BaseURI=
, "/elements/" + section);
>
>  Indentation.
>
>  Thanks,
>   - Jon



Thanks,  Mario

------=_Part_741_30953010.1203706182042
Content-Type: text/x-patch; name=ns.diff
Content-Transfer-Encoding: base64
X-Attachment-Id: f_fcz3kpzy
Content-Disposition: attachment; filename=ns.diff

SW5kZXg6IHByb3ZpZGVyLmNzCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0KLS0tIHByb3ZpZGVyLmNzCShyZXZpc2nDs246
IDk2NDExKQorKysgcHJvdmlkZXIuY3MJKGNvcGlhIGRlIHRyYWJham8pCkBAIC02MDksOSArNjA5
LDEzIEBACiAJCX0JCiAJfQogCQotCXB1YmxpYyB2b2lkIFBhY2tYbWwgKHN0cmluZyBmbmFtZSwg
WG1sRG9jdW1lbnQgZG9jKQotCXsKLQkJemlwX291dHB1dC5QdXROZXh0RW50cnkgKG5ldyBaaXBF
bnRyeSAoZm5hbWUpKTsKKwlwdWJsaWMgdm9pZCBQYWNrWG1sIChzdHJpbmcgZm5hbWUsIFhtbERv
Y3VtZW50IGRvYywgc3RyaW5nIHJlYWxfcGF0aCkKKwl7IAorCQlaaXBFbnRyeSBlbnRyeSA9IG5l
dyBaaXBFbnRyeSAoZm5hbWUpOyAKKwkJaWYgKHJlYWxfcGF0aCAhPSBudWxsKSAKKwkJCWVudHJ5
LkV4dHJhRGF0YSA9IENvbnZlcnRUb0FycmF5KHJlYWxfcGF0aCk7CisKKwkJemlwX291dHB1dC5Q
dXROZXh0RW50cnkgKGVudHJ5KTsKIAkJWG1sVGV4dFdyaXRlciB4bWxXcml0ZXIgPSBuZXcgWG1s
VGV4dFdyaXRlciAoemlwX291dHB1dCwgRW5jb2RpbmcuVVRGOCk7CiAJCWRvYy5Xcml0ZUNvbnRl
bnRUbyAoeG1sV3JpdGVyKTsKIAkJeG1sV3JpdGVyLkZsdXNoICgpOwpJbmRleDogbW9uby1lY21h
LWNzcy54c2wKPT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PQotLS0gbW9uby1lY21hLWNzcy54c2wJKHJldmlzacOzbjogOTY0
MTEpCisrKyBtb25vLWVjbWEtY3NzLnhzbAkoY29waWEgZGUgdHJhYmFqbykKQEAgLTY4NCw3ICs2
ODQsNyBAQAogCQkJCTx4c2w6YXBwbHktdGVtcGxhdGVzIHNlbGVjdD0ic3VtbWFyeSIgbW9kZT0i
bm90b3BwYXJhIi8+CiAJCQkJPHhzbDppZiB0ZXN0PSJtb25vZG9jOk1vbm9FZGl0aW5nKCkiPgog
CQkJCQk8eHNsOnZhbHVlLW9mIHNlbGVjdD0iJyAnIiAvPgotCQkJCQk8YSBocmVmPSJ7bW9ub2Rv
YzpFZGl0VXJsTmFtZXNwYWNlICgkbmFtZXNwYWNlLCAnc3VtbWFyeScpfSI+W0VkaXRdPC9hPgor
CQkJCQlbPGEgaHJlZj0ie21vbm9kb2M6RWRpdFVybE5hbWVzcGFjZSAoLiwgJG5hbWVzcGFjZSwg
J3N1bW1hcnknKX0iPkVkaXQ8L2E+XQogCQkJCTwveHNsOmlmPgogCQkJPC9kaXY+CiAKQEAgLTY5
Niw3ICs2OTYsNyBAQAogCQkJCTx4c2w6YXBwbHktdGVtcGxhdGVzIHNlbGVjdD0icmVtYXJrcyIv
PgogCQkJCTx4c2w6aWYgdGVzdD0ibW9ub2RvYzpNb25vRWRpdGluZygpIj4KIAkJCQkJPHhzbDp2
YWx1ZS1vZiBzZWxlY3Q9IicgJyIgLz4KLQkJCQkJPGEgaHJlZj0ie21vbm9kb2M6RWRpdFVybE5h
bWVzcGFjZSAoJG5hbWVzcGFjZSwgJ3JlbWFya3MnKX0iPltFZGl0XTwvYT4KKwkJCQkJWzxhIGhy
ZWY9Inttb25vZG9jOkVkaXRVcmxOYW1lc3BhY2UgKC4sICRuYW1lc3BhY2UsICdyZW1hcmtzJyl9
Ij5FZGl0PC9hPl0KIAkJCQk8L3hzbDppZj4KIAkJCQk8L2Rpdj4KIAkJCTwveHNsOmlmPgpJbmRl
eDogbW9uby1lY21hLnhzbAo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09Ci0tLSBtb25vLWVjbWEueHNsCShyZXZpc2nDs246
IDk2NDExKQorKysgbW9uby1lY21hLnhzbAkoY29waWEgZGUgdHJhYmFqbykKQEAgLTcxNyw3ICs3
MTcsNyBAQAogCQkJCTx4c2w6YXBwbHktdGVtcGxhdGVzIHNlbGVjdD0ic3VtbWFyeSIgbW9kZT0i
bm90b3BwYXJhIi8+CiAJCQkJPHhzbDppZiB0ZXN0PSJtb25vZG9jOk1vbm9FZGl0aW5nKCkiPgog
CQkJCQk8eHNsOnZhbHVlLW9mIHNlbGVjdD0iJyAnIiAvPgotCQkJCQk8YSBocmVmPSJ7bW9ub2Rv
YzpFZGl0VXJsTmFtZXNwYWNlICgkbmFtZXNwYWNlLCAnc3VtbWFyeScpfSI+W0VkaXRdPC9hPgor
CQkJCQlbPGEgaHJlZj0ie21vbm9kb2M6RWRpdFVybE5hbWVzcGFjZSAoLiwgJG5hbWVzcGFjZSwg
J3N1bW1hcnknKX0iPkVkaXQ8L2E+XQogCQkJCTwveHNsOmlmPgogCQkJPC9wPgogCkBAIC03Mjks
NyArNzI5LDcgQEAKIAkJCQk8eHNsOmFwcGx5LXRlbXBsYXRlcyBzZWxlY3Q9InJlbWFya3MiLz4K
IAkJCQk8eHNsOmlmIHRlc3Q9Im1vbm9kb2M6TW9ub0VkaXRpbmcoKSI+CiAJCQkJCTx4c2w6dmFs
dWUtb2Ygc2VsZWN0PSInICciIC8+Ci0JCQkJCTxhIGhyZWY9Inttb25vZG9jOkVkaXRVcmxOYW1l
c3BhY2UgKCRuYW1lc3BhY2UsICdyZW1hcmtzJyl9Ij5bRWRpdF08L2E+CisJCQkJCVs8YSBocmVm
PSJ7bW9ub2RvYzpFZGl0VXJsTmFtZXNwYWNlICguLCAkbmFtZXNwYWNlLCAncmVtYXJrcycpfSI+
RWRpdDwvYT5dCiAJCQkJPC94c2w6aWY+CiAJCQkJPC9ibG9ja3F1b3RlPgogCQkJPC94c2w6aWY+
CkluZGV4OiBlY21hLXByb3ZpZGVyLmNzCj09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT0KLS0tIGVjbWEtcHJvdmlkZXIuY3MJ
KHJldmlzacOzbjogOTY0MTEpCisrKyBlY21hLXByb3ZpZGVyLmNzCShjb3BpYSBkZSB0cmFiYWpv
KQpAQCAtMTg0LDYgKzE4NCw3IEBACiAJCQkJCWlmIChGaWxlLkV4aXN0cyAobnNfc3VtbWFyeV9m
aWxlKSkgewogCQkJCQkJWG1sRG9jdW1lbnQgbnNTdW1tYXJ5RmlsZSA9IG5ldyBYbWxEb2N1bWVu
dCAoKTsKIAkJCQkJCW5zU3VtbWFyeUZpbGUuTG9hZCAobnNfc3VtbWFyeV9maWxlKTsKKwkJCQkJ
CW5hbWVzcGFjZV9yZWFscGF0aCBbdG5dID0gbnNfc3VtbWFyeV9maWxlOwogCQkJCQkJCiAJCQkJ
CQlYbWxOb2RlIG5zX3N1bW1hcnkgPSBuc1N1bW1hcnlGaWxlLlNlbGVjdFNpbmdsZU5vZGUgKCJO
YW1lc3BhY2UvRG9jcy9zdW1tYXJ5Iik7CiAJCQkJCQlpZiAobnNfc3VtbWFyeSAhPSBudWxsICYm
IG5zX3N1bW1hcnkuSW5uZXJUZXh0ICE9ICJUbyBiZSBhZGRlZC4iICYmIG5zX3N1bW1hcnkuSW5u
ZXJUZXh0ICE9ICIiKSB7CkBAIC0yOTEsNyArMjkyLDcgQEAKIAkJCQllLkFwcGVuZENoaWxkIChj
b3B5KTsKIAkJCQllbGVtZW50cy5BcHBlbmRDaGlsZCAoZSk7CiAJCQl9Ci0JCQlocy5QYWNrWG1s
ICgieG1sLnN1bW1hcnkuIiArIG5zLCBkb2MpOworCQkJaHMuUGFja1htbCAoInhtbC5zdW1tYXJ5
LiIgKyBucywgZG9jLChzdHJpbmcpIG5hbWVzcGFjZV9yZWFscGF0aFtuc10pOwogCQl9CiAJCQog
CQkKQEAgLTMxMCwxMiArMzExLDEzIEBACiAJCQkJc3VtbWFyeS5BcHBlbmRDaGlsZCAobnNTdW1t
YXJ5LkNyZWF0ZUVsZW1lbnQoInN1bW1hcnkiKSk7CiAJCQkKIAkJfQotCQl0cmVlLkhlbHBTb3Vy
Y2UuUGFja1htbCAoIm1hc3RlcnN1bW1hcnkueG1sIiwgbnNTdW1tYXJ5KTsKKwkJdHJlZS5IZWxw
U291cmNlLlBhY2tYbWwgKCJtYXN0ZXJzdW1tYXJ5LnhtbCIsIG5zU3VtbWFyeSwgbnVsbCk7CiAJ
fQogCSAgICAgICAKIAlzdGF0aWMgSGFzaHRhYmxlIGNsYXNzX3N1bW1hcmllcyA9IG5ldyBIYXNo
dGFibGUgKCk7CiAJc3RhdGljIEhhc2h0YWJsZSBuYW1lc3BhY2Vfc3VtbWFyaWVzID0gbmV3IEhh
c2h0YWJsZSAoKTsKIAlzdGF0aWMgSGFzaHRhYmxlIG5hbWVzcGFjZV9yZW1hcmtzID0gbmV3IEhh
c2h0YWJsZSAoKTsKKwlzdGF0aWMgSGFzaHRhYmxlIG5hbWVzcGFjZV9yZWFscGF0aCA9IG5ldyBI
YXNodGFibGUgKCk7CiAJWG1sRG9jdW1lbnQgZG9jOwogCQogCXZvaWQgUG9wdWxhdGVDbGFzcyAo
c3RyaW5nIG5zLCBOb2RlIG5zX25vZGUsIHN0cmluZyBmaWxlKQpAQCAtODcwLDE1ICs4NzIsMTUg
QEAKIAkJCW1hdGNoX25vZGUgPSBuc19ub2RlOwogCQkJc3RyaW5nIG5zX25hbWUgPSBuc3VybC5T
dWJzdHJpbmcgKDIpOwogCQkJCi0JCQlYbWxSZWFkZXIgc3VtbWFyeSA9IEdldE5hbWVzcGFjZURv
Y3VtZW50IChuc19uYW1lKTsKLQkJCWlmIChzdW1tYXJ5ID09IG51bGwpCisJCQlYbWxEb2N1bWVu
dCBkb2MgPSBHZXRIZWxwWG1sV2l0aENoYW5nZXMoInhtbC5zdW1tYXJ5LiIgKyBuc19uYW1lKTsK
KwkJCWlmIChkb2MgPT0gbnVsbCkKIAkJCQlyZXR1cm4gbnVsbDsKIAogCQkJWHNsdEFyZ3VtZW50
TGlzdCBhcmdzID0gbmV3IFhzbHRBcmd1bWVudExpc3QoKTsKIAkJCWFyZ3MuQWRkRXh0ZW5zaW9u
T2JqZWN0KCJtb25vZG9jOi8vL2V4dGVuc2lvbnMiLCBFeHRPYmplY3QpOwogCQkJYXJncy5BZGRQ
YXJhbSgic2hvdyIsICIiLCAibmFtZXNwYWNlIik7CiAJCQlhcmdzLkFkZFBhcmFtKCJuYW1lc3Bh
Y2UiLCAiIiwgbnNfbmFtZSk7Ci0JCQlzdHJpbmcgcyA9IEh0bWxpemUobmV3IFhQYXRoRG9jdW1l
bnQgKHN1bW1hcnkpLCBhcmdzKTsKKwkJCXN0cmluZyBzID0gSHRtbGl6ZShkb2MsIGFyZ3MpOwog
CQkJcmV0dXJuIEJ1aWxkSHRtbCAoY3NzX2VjbWFfY29kZSwgcyk7IAogCiAJCX0KQEAgLTExODEs
MTAgKzExODMsMTIgQEAKIAkJCXJldHVybiAiIjsKIAkJfQogCi0JCXB1YmxpYyBzdHJpbmcgRWRp
dFVybE5hbWVzcGFjZSAoc3RyaW5nIG5zLCBzdHJpbmcgc2VjdGlvbikKKwkJcHVibGljIHN0cmlu
ZyBFZGl0VXJsTmFtZXNwYWNlIChYUGF0aE5vZGVJdGVyYXRvciBpdHIsIHN0cmluZyBucywgc3Ry
aW5nIHNlY3Rpb24pCiAJCXsKIAkJCWlmIChocyBpcyBFY21hVW5jb21waWxlZEhlbHBTb3VyY2Up
CiAJCQkJcmV0dXJuICJlZGl0OmZpbGU6IiArIFBhdGguQ29tYmluZSgoKEVjbWFVbmNvbXBpbGVk
SGVscFNvdXJjZSlocykuQmFzZVBhdGgsIG5zICsgIi54bWwiKSArICJAL05hbWVzcGFjZS9Eb2Nz
LyIgKyBzZWN0aW9uOyAKKwkJCWVsc2UgaWYgKGl0ci5Nb3ZlTmV4dCAoKSkKKwkJCQlyZXR1cm4g
RWRpdGluZ1V0aWxzLkZvcm1hdEVkaXRVcmkoaXRyLkN1cnJlbnQuQmFzZVVSSSwgIi9lbGVtZW50
cy8iICsgc2VjdGlvbik7CiAJCQlyZXR1cm4gIiI7CiAJCX0KIAo=
------=_Part_741_30953010.1203706182042
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Mono-docs-list maillist  -  [email protected]
http://lists.ximian.com/mailman/listinfo/mono-docs-list

------=_Part_741_30953010.1203706182042--