Giteveryday – A useful minimum set of commands for Everyday Git
1–10 of 53 posts
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#2Wow, a man page that is actually readable and understandable.
I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular.
But, the page linked in the OP is actually brilliant. It's easy to read, has examples, compartmentalises into sections that are relevant to different people. It's a step in the right direction.
Note: I'm not saying there aren't other pages like OP. There probably are, but the vast majority are not.
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#3Wow, a man page that is actually readable and understandable. I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular. But, the page linked in the…
One place where the MSDN docs is way ahead of the manpages is the documentation of function paramters. For instance, here's the ouput of man 2 write.
ssize_t write(int fd, const void *buf, size_t count);
DESCRIPTION
write() writes up to count bytes from the buffer pointed buf to the file referred to by the file descriptor fd.
The number of bytes written may be less than count if, for example, there is insufficient space on the underlying physical medium, or the RLIMIT_FSIZE resource limit is encountered (see setrlimit(2)), or call was interrupted by a signal handler after having written less than count bytes. (See also (7).)
For a seekable file (i.e., one to which lseek(2) may be applied, for example, a regular file) writing takes place at the file offset, and the file offset is incremented by the number of bytes actually written. If the file was open(2)ed with O_APPEND, the file offset is first set to the end of the file before writing. The adjustment of the file offset and the write operation are performed as an atomic step.
MSDN indexes the documentation by parameter so you can quickly find what you're interested in.
LE. Sample msdn link for comparison: https://msdn.microsoft.com/en-us/library/windows/desktop/aa3... .
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#4Wow, a man page that is actually readable and understandable. I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular. But, the page linked in the…
One place where the MSDN docs is way ahead of the manpages is the documentation of function paramters. For instance, here's the ouput of man 2 write . ssize_t write(int fd, const void *buf, size_t count); DESCRIPTION write() writes up to count bytes from the buffer pointed buf to the file referred to by the file descriptor fd. The number of bytes written may be less than count if, for example, there is insufficient s…
That's actually just one sentence you have to scan, so I don't totally see the issue.
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#5Wow, a man page that is actually readable and understandable. I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular. But, the page linked in the…
man pages are quite useful as reference documents. Which is their intended purpose.
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#6Wow, a man page that is actually readable and understandable. I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular. But, the page linked in the…
Try a project like freebsd or openbsd for better man pages that are centrally curated.
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#7Wow, a man page that is actually readable and understandable. I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular. But, the page linked in the…
One place where the MSDN docs is way ahead of the manpages is the documentation of function paramters. For instance, here's the ouput of man 2 write . ssize_t write(int fd, const void *buf, size_t count); DESCRIPTION write() writes up to count bytes from the buffer pointed buf to the file referred to by the file descriptor fd. The number of bytes written may be less than count if, for example, there is insufficient s…
That's under Linux (not sure if that man page is maintained by glibc or the kernel seeing as it is a syscall).
That's pretty different under a system that cares : http://man.openbsd.org/OpenBSD-current/man2/write.2
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#8Wow, a man page that is actually readable and understandable. I've been using Linux for years, and never once have I seriously looked at a man page. One of the more useless pieces of advice Linux beginners are given is to `man [tool]`. The documentation often has tonnes of useless information and no examples. It's frustrating, and it's also why projects like tldr[0] have gotten so popular. But, the page linked in the…
> One of the more useless pieces of advice Linux beginners are given is to `man [tool]`.
On the other hand, when I was first introduced to Linux ~20 years ago, I didn't have an "always-on" Internet connection and web sites weren't that popular.
Probably 90% of what I learned in the first few years or so came from the man pages and a locally downloaded copy of the guides and howto's from TLDP [0].
I might also mention that not all man pages are created equal. I've seen some in Ubuntu that serve no purpose other than wasting bytes on the disk while some of those in OpenBSD act as a single source for everything one needs to know about .
[0]: http://www.tldp.org/
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#9Earlier quoted context omitted.
One place where the MSDN docs is way ahead of the manpages is the documentation of function paramters. For instance, here's the ouput of man 2 write . ssize_t write(int fd, const void *buf, size_t count); DESCRIPTION write() writes up to count bytes from the buffer pointed buf to the file referred to by the file descriptor fd. The number of bytes written may be less than count if, for example, there is insufficient s…
That's under Linux (not sure if that man page is maintained by glibc or the kernel seeing as it is a syscall). That's pretty different under a system that cares : http://man.openbsd.org/OpenBSD-current/man2/write.2
I'm sorry, how is it different than the linux example?
They both describe all the parameters in the first sentence of the description.
Re: Giteveryday – A useful minimum set of commands for Everyday Git
#10Earlier quoted context omitted.
One place where the MSDN docs is way ahead of the manpages is the documentation of function paramters. For instance, here's the ouput of man 2 write . ssize_t write(int fd, const void *buf, size_t count); DESCRIPTION write() writes up to count bytes from the buffer pointed buf to the file referred to by the file descriptor fd. The number of bytes written may be less than count if, for example, there is insufficient s…
That's actually just one sentence you have to scan, so I don't totally see the issue.
It could still be better. It could be 0 sentences to scan it it was formatted in a better way.