Ticket #1742 (closed task: fixed)
DocHelp - major overhaul
| Reported by: | randomandy | Owned by: | Chris Arndt |
|---|---|---|---|
| Priority: | normal | Milestone: | 1.0 |
| Component: | Documentation | Version: | 1.0 |
| Severity: | normal | Keywords: | doc review |
| Cc: |
Description
Here is a major overhaul of the DocHelp page.
Chris Arndt's snippet page links to an unpermitted page view so I commented it out until this can be corrected.
I expect the submission protocol to be further refined by others, but as that happens I think this organization will help accomodate it.
Attachments
-
DocHelpRevision.txt
(14.8 KB) -
added by randomandy 4 years ago.
- diff
-
NewDocHelp
(11.0 KB) -
added by randomandy 4 years ago.
- Slightly improved from previous
Change History
Changed 4 years ago by randomandy
-
attachment
DocHelpRevision.txt
added
comment:1 Changed 4 years ago by Chris Arndt
- Status changed from new to assigned
The patch does not apply cleanly:
$ patch <DocHelpRevision.diff patching file OldDocHelp Hunk #1 FAILED at 16. Hunk #2 FAILED at 82. Hunk #3 FAILED at 91. Hunk #4 FAILED at 114. Hunk #5 FAILED at 127. Hunk #6 FAILED at 220. Hunk #7 FAILED at 251. Hunk #8 FAILED at 261. 8 out of 8 hunks FAILED -- saving rejects to file OldDocHelp.rej
Can you make sure that the patch applies on your system to the DocHelp page as directly downloaded through the "Raw Text" function on the bottom of the page?
BTW, It is customary to name diff files with a .diffor .patch extension.
comment:2 Changed 4 years ago by randomandy
It seems to work for me. I think the only problem is the filenames for the original vs new file. I used my local file names in the diff file. What should they be? Should it be DocHelp for both?
comment:3 Changed 4 years ago by Chris Arndt
No, I named the original page OldDocHelp when I downloaded it, so this should not be the problem. Maybe I'm just getting something wrong with the patch command. I'm only used to applying patches to the SVN repository where it usually just works.
Can you maybe just attach the changed file and I will test how to create a proper diff and apply it, or I'll just upload your changed file?
comment:4 Changed 4 years ago by randomandy
I attached the new version in its entirety. I didn't get a ticket-update email, so I'm adding this comment.
comment:5 Changed 4 years ago by randomandy
This is almost the same file as I uploaded before, but I just figured out how to do some markups that I kind of hacked before. This corrects that and adds a line at the bottom.
diff