sierrafoxtrot / srecord

SRecord github Mirror
https://srecord.sourceforge.net/
GNU General Public License v3.0
42 stars 22 forks source link

[BUG] Broken links in documentation #39

Open oceanofthelost opened 1 year ago

oceanofthelost commented 1 year ago

Following man pages have a link to external resource which no longer works:

  1. srec_aomf(5)
  2. srec_binary(5)
  3. srec_brecord(5)
  4. srec_emon52(5)
  5. srec_fpc(5)
  6. srec_mos_tech(5)
  7. srec_mif(5)
  8. srec_signetics(5)
  9. srec_ti_tagged(5)
  10. srec_ti_tagged_16(5)
  11. srec_wilson(5)
oceanofthelost commented 1 year ago

I can try and find alternative links for each case, unless someone has existing copies.

Should external references live under the etc folder or an external folder? This would remove the need for relying on an external site always being present.

oceanofthelost commented 1 year ago

Using Wayback Machine

  1. srec_emon52
  2. srec_fpc
  3. srec_signetics
marcows commented 1 year ago

See also https://github.com/marcows/SRecord-deprecated/commit/2e8540a9422be16960349f64b2dca7abafc3403f for some website address fixes.

More than 8 years old, might be outdated partially.

jtxa commented 1 year ago

I would suggest Wayback machine, if no successor of that page exists.

The local crc16-ccitt.html file was retrieved from Wayback machine. Should we do it also this way? Personally, I would remove that file and replace it by the link. No need to add different copyright things into the repository.

Perhaps add a github link checker action. Not on PRs, but cyclic once a month or so. I don't know which one is good, this one was my first google hit: https://github.com/marketplace/actions/check-links-with-linkcheck

oceanofthelost commented 1 year ago

I would agree having some kind of link checker on a periodic basis would be beneficial to make sure links are still valid.

sierrafoxtrot commented 1 year ago

I've started playing with linkcheck, lychee and others. Sadly, unless I'm doing something silly (which is never out of the question) they don't seem to be quite up to the task. A lot of these tools are great for picking dead links unless they genuinely 404. Many won't even explore external links as their main job appears to be chekcing integrity of a static website. I'd be thrilled if we can find a suitable one though.

However, if they land on a "not found" page such as http://www.elsist.net/WebSite/ftp/various/OMF51EPS.pdf (linked from srec_aomf.5), the tools will just pass as the http get worked ok.

Open to suggestions.

Regarding the approach to deadends, I totally agree with the Wayback machine approach if there isn't a clear successor. I fixed a couple of links this way last year and it seems solid.