Zachary Turner via llvm-dev
2016-Dec-13 17:45 UTC
[llvm-dev] LLVM Documentation - How does it get updated?
Over a month ago I submitted some patches to begin documenting PDB file format. These files are in llvm/docs/PDB. When I view the docs online though, they appear stale. Many of the pages are blank, containing only a file header. This matches up with my initial commit of the documentation, as I initially just created stub pages, but as I continued to improve the documentation, the website never got updated again. There are at least 3-4 stale pages, but one easy one to see is http://llvm.org/docs/PDB/DbiStream.html. If you look in llvm/Docs/PDB/DbiStream.rst the file is 18K and contains a ton of information, but the page above is just blank. I built the documentation target locally and when I view the locally generated documentation, everything is fine. So it is only a problem with the website. Does anyone know how I can get this resolved or who i need to talk to? -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20161213/38990893/attachment.html>
Hans Wennborg via llvm-dev
2016-Dec-13 17:48 UTC
[llvm-dev] LLVM Documentation - How does it get updated?
On Tue, Dec 13, 2016 at 9:45 AM, Zachary Turner via llvm-dev <llvm-dev at lists.llvm.org> wrote:> Over a month ago I submitted some patches to begin documenting PDB file > format. These files are in llvm/docs/PDB. When I view the docs online > though, they appear stale. Many of the pages are blank, containing only a > file header. This matches up with my initial commit of the documentation, > as I initially just created stub pages, but as I continued to improve the > documentation, the website never got updated again. > > There are at least 3-4 stale pages, but one easy one to see is > http://llvm.org/docs/PDB/DbiStream.html. If you look in > llvm/Docs/PDB/DbiStream.rst the file is 18K and contains a ton of > information, but the page above is just blank. > > I built the documentation target locally and when I view the locally > generated documentation, everything is fine. So it is only a problem with > the website. > > Does anyone know how I can get this resolved or who i need to talk to?Anton and/or Tanya, I think (cc'd).
Renato Golin via llvm-dev
2016-Dec-13 18:00 UTC
[llvm-dev] LLVM Documentation - How does it get updated?
On 13 December 2016 at 17:45, Zachary Turner via llvm-dev <llvm-dev at lists.llvm.org> wrote:> Over a month ago I submitted some patches to begin documenting PDB file > format. These files are in llvm/docs/PDB. When I view the docs online > though, they appear stale. Many of the pages are blank, containing only a > file header. This matches up with my initial commit of the documentation, > as I initially just created stub pages, but as I continued to improve the > documentation, the website never got updated again.Hi Zachary, I can confirm the docs build normally on my machine, too. Did you check when you first committed that the docs were good upstream?> I built the documentation target locally and when I view the locally > generated documentation, everything is fine. So it is only a problem with > the website.I have Sphinx 1.5 here, but the website is using 1.4.5. What's the version you're using? I can see some warnings on my side, but there could be some errors on the website, which would be the reason why they're empty. My local warnings: reading sources... [100%] yaml2obj /home/rengolin/devel/llvm/worktree/docs/llvm/docs/CommandGuide/lit.rst:64: WARNING: Duplicate explicit target name: "cmdoption-D". looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... WARNING: search index couldn't be loaded, but not all documents will be built: the index will be incomplete. done I also found some CMake errors on that build that I'll fix. No other doc was being updated for a while...:( cheers, --renato
Zachary Turner via llvm-dev
2016-Dec-13 18:03 UTC
[llvm-dev] LLVM Documentation - How does it get updated?
Yes when I first committed the docs were fine upstream. I think I even got 1 or 2 additional commits that I could see the changes of reflected on the website. At some point though, it just stopped updating (I don't know which exact CL). I can find a date range of when things stopped being update if that would be helpful. If I look at the PDB documentation now (which is rooted here <http://llvm.org/docs/PDB/index.html>) it's all consistent with a certain point in time (again, I'd have to find the exact CL), but nothing after that point in time ever made it in. On Tue, Dec 13, 2016 at 10:00 AM Renato Golin <renato.golin at linaro.org> wrote:> On 13 December 2016 at 17:45, Zachary Turner via llvm-dev > <llvm-dev at lists.llvm.org> wrote: > > Over a month ago I submitted some patches to begin documenting PDB file > > format. These files are in llvm/docs/PDB. When I view the docs online > > though, they appear stale. Many of the pages are blank, containing only > a > > file header. This matches up with my initial commit of the > documentation, > > as I initially just created stub pages, but as I continued to improve the > > documentation, the website never got updated again. > > Hi Zachary, > > I can confirm the docs build normally on my machine, too. Did you > check when you first committed that the docs were good upstream? > > > > I built the documentation target locally and when I view the locally > > generated documentation, everything is fine. So it is only a problem > with > > the website. > > I have Sphinx 1.5 here, but the website is using 1.4.5. What's the > version you're using? > > I can see some warnings on my side, but there could be some errors on > the website, which would be the reason why they're empty. > > My local warnings: > > reading sources... [100%] yaml2obj > /home/rengolin/devel/llvm/worktree/docs/llvm/docs/CommandGuide/lit.rst:64: > WARNING: Duplicate explicit target name: "cmdoption-D". > looking for now-outdated files... none found > pickling environment... done > checking consistency... done > preparing documents... WARNING: search index couldn't be loaded, but > not all documents will be built: the index will be incomplete. > done > > I also found some CMake errors on that build that I'll fix. No other > doc was being updated for a while...:( > > cheers, > --renato >-------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20161213/11ae09fb/attachment-0001.html>