עורך מקורות של Git

סקירה כללית

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

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

התחברות

  1. טוענים את הכלי לעריכת מקורות ב-Git בדפדפן.
  2. לוחצים על התחברות כדי להיכנס לחשבון.

    כפתור התחברות

    איור 1. כפתור התחברות

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

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

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

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

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

טעינת קבצים

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

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

  2. לוחצים על טעינת קובץ או שינוי.

    טעינת קובץ או שינוי

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

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

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

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

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

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

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

טעינת שינוי

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

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

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

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

מבצעים את השינויים הרצויים.

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

שליחת השינויים

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

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

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

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

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

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

    תיבת הדו-שיח 'יצירת שינוי'

    איור 5. תיבת הדו-שיח 'יצירת שינוי'

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

  3. אופציונלי: מבטלים את הסימון בתיבת הסימון פרסום בעת יצירה או מסמנים אותה.

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

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

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

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

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

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

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

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

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

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

הצגת ההבדלים בין קבצים

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

הצגת הבדלים בין קבצים

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

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

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

החזרה של קובץ יחיד לגרסה קודמת

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

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

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

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

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

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

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

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

תיבת דו-שיח לאישור ביטול כל השינויים

איור 11. תיבת דו-שיח לאישור ביטול כל השינויים

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

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

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

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

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

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

    הכלי לעריכת מקורות ב-Git נפתח כשהקובץ כבר מסומן לעריכה.

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

    בחירת ענף Git לעריכה

    איור 13. בחירת ענף Git לעריכה

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

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

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

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

כדי לפתור את העימותים:

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

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

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

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

    סמני התנגשות

    איור 15. סמני קונפליקט בכלי לעריכת מקורות

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

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

    יצירת שינוי

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

  5. כותבים תיאור לשינוי ולוחצים על יצירה.

שליחת משוב

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