10.5 "Git Internals - The Refspec" misleading about what "refspecs" are

Abierto
#1,999 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
git
Área
documentation

Línea de trabajo

Locate the Pro Git source for section 10.5, “Git Internals - The Refspec,” and compare it with the rendered website or PDF. Review the title and surrounding text for the requested refspec terminology and definition, then verify that the updated section renders correctly in both book formats.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug
There's no existing/similar bug report.
  • I have searched the existing issues
This report is about a single actionable bug.
  • I'm reporting a single actionable bug
This report is about the ProGit book, version 2, English language.
  • This bug is not about a translation or old version
Bug covers book website/pdf
  • I confirm the bug is about the book as found on the website/pdf
Problem is present in the Pro Git book on the website?
  • This bug also affects the Pro Git book as published on the website.
Which version of the book is affected?

Source files

Describe the bug:

Section 10.5 Git Internals - The Refspec of the book can be misleading/confusing about "refspecs". I did not know/remember anything about refspecs last week, but visibly, the title itself has a couple issues:

  1. The section itself has several mentions of "multiple refspecs" as well as the "default refspec", so the title should visibly read "Refspecs", not "The Refspec".
  2. A look at git pull --help suffices to see several leaks (more than 5 references to refspecs as of Git 2.47). If refspecs were meant to be an internal, they are clearly far from having reached that status.

Of course, defining refspecs would help.

Steps to reproduce:

This does not report a behavioral bug.

Expected behavior:

This does not report a behavioral bug.

Screenshots:

No response

Additional context:

No response

Device

No response

Operating system

No response

Browser/application + version

No response

Lenguaje dominante
CSS
Estrellas
6.6k
Forks
2.1k
Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de progit/progit2

Todos los issues de progit/progit2

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.