[PATCH 0/3] Some small fixes to glossary-content.txt
While proof-reading the user-manual I noticed some issues with glossary-content.txt: - There is some outdated, misleading or irrelevant information which might only confuse new Git users and should therefore be removed. - The entries for object, object name and SHA1 lacked a little bit of consistency. - The glossary contains partial definitions for refspec and pathspec. The refspec definition was replaced by a link to the git-push man-page. I also removed the definition for pathspec but didn't find a single place where pathspecs are defined. The glossary surely is the wrong place for a complete definition, but is there something missing here or is it sufficient to spread the definition of pathspecs to the relevant man-pages? [PATCH 1/3] Remove outdated/missleading/irrelevant entries from glossary-content.txt [PATCH 2/3] Improve description of SHA1 related topics in glossary-content.txt [PATCH 3/3] Remove definition of refspec and pathspec from glossary-content.txt --- Thomas -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 0/3] Some small fixes to glossary-content.txt
Thomas Ackermann th.ac...@arcor.de writes: While proof-reading the user-manual I noticed some issues with glossary-content.txt: - There is some outdated, misleading or irrelevant information which might only confuse new Git users and should therefore be removed. - The entries for object, object name and SHA1 lacked a little bit of consistency. - The glossary contains partial definitions for refspec and pathspec. Only on the partial bit, and not limited to refspec and pathspec. I think ideally for any key concepts: - The glossary should mention what it is and what it is used for; - Individual manual pages should mention how it is constructed and how it can be used. To be complete, it may need to start by describing what it is and what it is used for, which may have to duplicate what we say in the glossary. -- To unsubscribe from this list: send the line unsubscribe git in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
