search

linux-test-project / lcov

LCOV
GNU General Public License v2.0
892 stars 239 forks source link

web page missing #151

Open GitMensch opened 2 years ago

GitMensch commented 2 years ago

The content of http://ltp.sourceforge.net/coverage/lcov.php is missing here - should I send a PR for including this as README.md or as separate file under docs? Should those go into the LPT repo?

oberpar commented 2 years ago

The web page content should really replace the existing README. Converting it to .MD format should be easy enough, but I'm seeing two open questions:

  1. How to automatically generate the web page screenshots and where to store them (e.g. as part of the source code?)
  2. Where to store the rendered HTML example and how to host them on github so that they can be directly referenced from the new README.

I've been working on creating a make web target that would create both screenshots and HTML files using the current lcov version. These files could then be added to a separate branch for use with the github pages feature. But again, I haven't concluded this work.

Since many files will be touched by the diffcov feature merge I would prefer to hold off PRs for these changes until after that merge.

GitMensch commented 2 years ago

That sounds nice but quite complicated - I'd just have put everything (new markdown files for lcov and gcov, images, sample generated HTML) under "docs" and if someone wants to update the screenshots manual or by running a (later) make web then this would be just regenerated.

As "where to store them": I vote for "in source tree" - if I do a local checkout they don't harm and may be even useful (at least for adjusting those).

Which diffcov feature do you mean? Is there a PR or patch for that and possibly an ETA?

oberpar commented 2 years ago

You may have a point about keeping things simple and storing the HTML as part of the source tree - I'll need to think about that some more.

The diffcov feature I'm referring to is in PR #86. The ETA for that is.. 1.5 years ago :) But to be serious - I'm currently working on it, hoping that it won't take that much longer, but can't give an actual ETA.

GitMensch commented 1 year ago

Any updates on this? Would it help to create a PR to change the current README to README.md?

oberpar commented 1 year ago

I've started work on this ~1 month ago but had to drop that half-way for higher-priority work. I don't see too much added value in simply converting the current README to MD format. We really want to have similar content as on the web page, i.e. screenshots, formatted man pages, a quick start guide. Ideally all the detailed information would be split out to another MD file (a "guide" of sorts).