OSDev.org
https://forum.osdev.org/

osdev wiki dedicated git resource
https://forum.osdev.org/viewtopic.php?f=8&t=34313
Page 1 of 1

Author:  ajxs [ Thu Sep 05, 2019 11:08 pm ]
Post subject:  osdev wiki dedicated git resource

This is just a thought I had.
When supplying code snippets for wiki articles and tutorials, the wiki provides adequate facilities. However there are times where authors have had to provide entire source files one after another in a single article, this is obviously not ideal. In some other cases authors have provided links to external git repositories to provide more complete examples.
I was thinking that it might be an idea to create a central git repository or account on a VCS hosting service ( github, gitlab, etc ) to be used as a central repository for examples used in the wiki.
In many cases I find it much easier to pore through source code in my own editor than read it online, so being able to check out resources and examples I'm studying is much easier. There is definitely a small administrative overhead, but I think there's some benefits.

Author:  Solar [ Fri Sep 06, 2019 6:31 am ]
Post subject:  Re: osdev wiki dedicated git resource

I do not see where this would be helpful.

Either your source is open; then you usually already have it residing in a publically accessible repository.

Or your source isn't open. Then there's already places like Pastebin.

Creating / checking into a repository for the sole purpose of posting to OSDev sounds like a pretty nuisance for me. I also take exception at Git being considered some kind of "gold standard" of VCS. It isn't.

Author:  ajxs [ Fri Sep 06, 2019 6:08 pm ]
Post subject:  Re: osdev wiki dedicated git resource

Quote:
Either your source is open; then you usually already have it residing in a publically accessible repository.
Or your source isn't open. Then there's already places like Pastebin.
Creating / checking into a repository for the sole purpose of posting to OSDev sounds like a pretty nuisance for me.

I didn't intend to introduce any new methodology for posting code to the wiki or sharing user projects. My idea was intended to address the cases where users are already linking external repositories to the wiki. Commonly this contains supplementary code. Or fully assembled examples in the case of the 'Bare Bones' series of articles. My thinking was that it would bring the code provided under shared control, which might help avoid 404's in the case that the hosting user removes their work, or allow for the code to evolve with the associated osdev wiki article.

There's currently only a few wiki pages I could find that link to examples hosted as online source control resources. I should have checked before posting the topic, but you can see them below:

    https://wiki.osdev.org/Bare_Bones
    https://wiki.osdev.org/C_Sharp_Bare_Bones
    https://wiki.osdev.org/Ada_Bare_bones
    https://wiki.osdev.org/Meaty_Skeleton
    https://wiki.osdev.org/ARM_Integrator-CP_IRQTimerPICTasksMMAndMods
    https://wiki.osdev.org/ARM_Integrator-CP_ITPTMME_Phase2
    https://wiki.osdev.org/Ada_Kalinda

I'll admit a few of these are a little obscure.

Solar wrote:
I also take exception at Git being considered some kind of "gold standard" of VCS. It isn't.

You can have this argument with someone else, I'm not interested. I could possibly have used a more generic term in the title, but I think the word 'git' in the title conveys the point adequately.

My original thought was that a central repository would help for users to make corrections and improvement to supplemental code provided for the wiki. Such as that linked to by many of the 'bare bones' articles above. I guess that might be out of the scope of the wiki, and creating a pull request or similar to the repo and updating the wiki might be a bit onerous.
I'm not too upset about this if others aren't interested, it was just an idea! I'm willing to leave the idea here if no one else thinks this resource can be useful.

Page 1 of 1 All times are UTC - 6 hours
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group
http://www.phpbb.com/