עורך מקור של Git

סקירה כללית

עורך המקור של Git (ci.android.com/edit) הוא כלי מבוסס-דפדפן לעריכת קבצים בפרויקט Android Open Source Project‏ (AOSP) ולהעלאת שינויים ל-Gerrit. הוא מיועד לביצוע שינויים קלים במספר קטן של קבצים, ומספק תהליך עבודה מהיר יותר מהורדת עץ המקור של Android. לפני שמשתמשים בעורך מקורות של Git, צריך להכיר את התהליך המלא לשליחת שינויים ל-AOSP באמצעות Git, ‏ Repo ו-Gerrit.

כשעורכים קובץ באמצעות עורך המקור של Git, כל העבודה מתבצעת במחשב המקומי, עד שמעלים את השינויים כדי ליצור רשימת שינויים ב-Gerrit.

התחברות

  1. טוענים את Git Source Editor בדפדפן.
  2. לוחצים על Log in (כניסה) כדי להיכנס לחשבון.

    לחצן התחברות

    איור 1. לחצן התחברות

עריכת קבצים ושינויים

אלה תהליכי העבודה העיקריים ב-Git Source Editor:

  • עורכים קובץ אחד או יותר לבחירתכם, בהסתעפות שבחרתם.
  • עריכת שינוי. כשעורכים שינוי, התוצאה תלויה בזהות היוצר שלו:
    • אם אתם יוצרים את השינוי, העריכות שלכם ב-Git Source Editor יתווספו לשינוי כקבוצת תיקונים חדשה.
    • אם מישהו אחר יצר את השינוי, העריכות שלכם ב-Git Source Editor ייצרו שינוי חדש שבבעלותכם, על סמך השינוי שהעליתם.

טוענים את מה שרוצים לערוך

כדי להתחיל סשן עריכה, אפשר לטעון קובץ או שינוי.

טעינת קבצים

  1. מזינים את כתובת ה-URL של הקובץ שרוצים לערוך בתיבה file/change path בחלק העליון של הדף.

    נתיב קובץ לדוגמה: https://android.googlesource.com/platform/build/+show/refs/heads/main/Changes.md

  2. לוחצים על Load file or change.

    טעינה של קובץ או שינוי

    איור 2. טעינה של קובץ או שינוי

    הקובץ נטען בחלונית העריכה. חלונית הניווט שמשמאל לחלונית העריכה היא דפדפן קבצים, שפותח את המאגר עם הקובץ טעון מראש.

    קובץ שנטען בחלונית העריכה

    איור 3. קובץ שנטען בחלונית העריכה

אפשר להשתמש בחלונית הניווט כדי לפתוח קבצים נוספים באותו מאגר. אם פותחים כמה קבצים, כל קובץ מופיע ככרטיסייה בשורה שמעל חלונית העריכה. לוחצים על כרטיסייה כדי לפתוח את הקובץ בחלונית העריכה.

כרטיסיות של קבצים טעונים

איור 4. כרטיסיות של קבצים טעונים

טעינת שינוי

כדי לנווט לשינוי שרוצים לערוך, מזינים את כתובת ה-URL של רשימת השינויים ב-Gerrit בתיבה file/change path בחלק העליון של הדף (ראו איור 2).

קישור לדוגמה לשינוי: https://android-review.googlesource.com/c/platform/build/soong/+/1284176

הקבצים שבשינוי ייפתחו בחלונית העריכה (ראו איור 3).

אם השינוי כולל כמה קבצים, כל קובץ יופיע ככרטיסייה בשורה שמעל חלונית העריכה (ראו איור 4). לוחצים על כרטיסייה כדי לפתוח את הקובץ בחלונית העריכה.

מבצעים את העריכות

עריכת קבצים באמצעות חלונית עריכת הטקסט. הקבצים שאתם עורכים מופיעים ברשימה Pending changes (שינויים בהמתנה) מתחת לחלונית העריכה. אם סגרתם בטעות את הכרטיסייה של קובץ עם שינויים, תוכלו לפתוח מחדש את הקובץ עם השינויים ללא שינוי בלחיצה על השם שלו ברשימה 'שינויים בהמתנה'.

שלח שינויים

יוצרים את השינוי ב-Gerrit ומפרסמים אותו ב-Git Source Editor. לאחר מכן תוכלו לעקוב אחרי אישור השינוי ב-Gerrit.

יצירה ופרסום של השינויים

יש לפעול לפי התהליך הזה כדי ליצור ולפרסם את השינויים שביצעתם.

  1. לוחצים על הלחצן המתאים:

    • אם יוצרים שינוי חדש, לוחצים על יצירת שינוי.
    • אם מעדכנים שינוי קיים, לוחצים על עדכון השינוי.

    תיפתח תיבת דו-שיח.

    תיבת הדו-שיח Create Change

    איור 5. תיבת הדו-שיח Create Change

  2. מזינים תיאור של השינוי, שיהיה תיאור השינוי ב-Gerrit. חובה להזין את התיאור הזה. אם אתם עורכים שינוי קיים, תוכלו לערוך את התיאור שלו אם תרצו.

  3. אם רוצים, מבטלים את הסימון של התיבה Publish on create (פרסום בזמן היצירה) או מסמנים אותה.

    התיבה הזו מסומנת כברירת מחדל.

    אם התיבה הזו מסומנת כשיוצרים את השינוי, השינוי יפורסם מיד ב-Gerrit. אם התיבה לא מסומנת, השינוי יועלה ל-Gerrit אבל לא יפורסם.

  4. לוחצים על יצירה.

    השינוי מועלה ל-Gerrit. אם סימנתם את התיבה Publish on create, השינוי יפורסם גם ב-Gerrit. השינוי מופיע בהודעה בחלק העליון של המסך.

    שינוי ההתראה שנוצרה

    איור 6. שינוי ההתראה על יצירה

מעקב אחרי אישור שינויים ב-Gerrit

לעקוב אחרי סטטוס שליחת השינויים ישירות ב-Gerrit, כמו בכל שינוי אחר.

מעקב אחר סטטוס שליחת השינויים ב-Gerrit

איור 7. מעקב אחר סטטוס שליחת השינויים ב-Gerrit

הצגת ההבדלים בין גרסאות של קבצים

כדי להציג את השינויים שביצעתם בקובץ הפעיל בחלונית העריכה, מסמנים את התיבה Diff מתחת לחלונית העריכה. אפשרות זו שימושית כשמשנים קובץ וכשעורכים שינוי קיים.

הצגת ההבדלים בין גרסאות של קבצים

איור 8. הצגת ההבדלים בין גרסאות של קבצים

החזרת קבצים למצב הקודם

אפשר לבטל שינויים בקובץ יחיד או בכל הקבצים ברשימת השינויים בהמתנה. שתי האפשרויות להחזרת השינויים מבטלות אותם רק ב-Git Source Editor. הם לא יעדכנו את השינוי ב-Gerrit.

חזרה לקובץ אחד

כדי לבטל את השינויים בקובץ יחיד, לוחצים על הסמל X לצד שם הקובץ ברשימה 'שינויים בהמתנה'.

הקטע 'שינויים בהמתנה'

איור 9. הקטע 'שינויים בהמתנה'

ביטול השינויים בכל הקבצים

כדי לבטל את השינויים בכל הקבצים בבת אחת, לוחצים על ביטול השינויים בכל הקבצים מתחת לחלונית העריכה.

לחצן החזרה של כל הקבצים

איור 10. לחצן החזרה של כל הקבצים

תיפתח תיבת דו-שיח קופצת. לוחצים על ביטול כל השינויים כדי לבטל את השינויים בכל הקבצים בהמתנה, או על ביטול כדי לשמור את השינויים ולהמשיך לערוך.

תיבת הדו-שיח לאישור החזרת כל הקבצים

איור 11. תיבת הדו-שיח לאישור החזרת כל הקבצים

אפשר לפתוח קובץ ב-Git Source Editor ישירות מחיפוש הקוד של Android. כדאי להיעזר בזה אם אתם צריכים לאתר את הקובץ לפני שאתם עורכים אותו.

כדי לערוך קובץ ישירות מחיפוש הקוד של Android, פועלים לפי השלבים הבאים:

  1. ב-Android Code Search‏ (cs.android.com), עוברים לקובץ שרוצים לערוך.

  2. לוחצים על עריכת הקוד.

    לחצן עריכת הקוד ב-Android Code Search

    איור 12. הלחצן עריכת קוד ב-Android Code Search

    עורך המקור של Git ייפתח עם הקובץ שנבחר מראש לעריכה.

  3. ברשימה הנפתחת Select a git branch, בוחרים את ההסתעפות ב-Git שבה רוצים לערוך את הקובץ ולוחצים על Pick branch.

    בחירת ההסתעפות ב-Git שרוצים לערוך

    איור 13. בחירת ההסתעפות ב-Git שרוצים לערוך

    הקובץ נפתח בחלונית העריכה.

  4. ממשיכים לערוך לפי ההוראות שמפורטות בקטע ביצוע העריכות.

  5. אפשר לפתוח קבצים נוספים לעריכה, כפי שמתואר בקטע טעינת קבצים.

פתרון התנגשויות

כדי לפתור את ההתנגשויות:

  1. עוברים אל השינוי ב-Source Editor. אחרי שהשינוי נטען, הקבצים המתנגשים מפורטים בחלק התחתון של המסך. לדוגמה, באיור 14 מוצג קובץ Android.pb עם אירוע חופף.

    התנגשות בין עורכי מקור

    איור 14. התנגשות בין עורכי מקור

  2. לוחצים על קובץ עם התנגשות. הקובץ נטען ומוצגים בו ברצף בלוקים של תוכן בעלי תוכן מתנגש, בתוך סמלי Git‏ (<<<<<<< ו->>>>>>>).

    סמנים של התנגשויות

    איור 15. סמני התנגשויות של עורך המקור

  3. כדי לפתור את הבעיה, עורכים את הקובץ ומסירים ידנית את סמני ההתנגשות סביב התוכן שרוצים לשמור. בנוסף, מסירים את התוכן ואת סמני העימות של התוכן שלא רוצים לשמור.

  4. לוחצים על Create Change (יצירת שינוי) כדי ליצור שינוי חדש. תיבת הדו-שיח Create Change מופיעה.

    יצירת שינוי

    איור 16. יצירת שינוי

  5. מקלידים תיאור של השינוי ולוחצים על יצירה.

שליחת משוב

כדי לשלוח משוב על Git Source Editor, לוחצים על לחצן הדיווח על באגים תמונה של לחצן הדיווח על באג בפינה השמאלית העליונה.